From b8e58e9b60dea68433c760fab35ff1669da25566 Mon Sep 17 00:00:00 2001 From: dahn Date: Tue, 31 Dec 2024 12:25:06 +0100 Subject: [PATCH] update listApis.json, Quota API, and fixed double url value handling (based on #90) (#98) * listApis.json update * add initial comments for expanding Quota api * implement QuotaBalance * implement QuotaCredits * implement QuotaStatement * implement QuotaSummary * implement QuotaTariffCreate * implement QuotaTariffDelete * implement QuotaTariffList * implemented QuotaTariffUpdate * implemented QuotaUpdate * fix url values * add NewQuotaUpdateParams for QuotaUpdate * add missing quota api functions to layout.go * ran make and it auto updated manual changes to QuotaService.go * fix url value generation for double/float64 types * update generated files * ensure that quotaTariffCreate uses POST * fix types for QuotaService * fix quotaTariffList * add custom quotaStatement response type to match actual cloudstack api response * add custom response type for QuotaBalance * double API definition fixed * add quotaTariffList * regenerate mocks * Update cloudstack/cloudstack.go --------- Co-authored-by: tonymmm1 --- cloudstack/QuotaService.go | 1709 + cloudstack/QuotaService_mock.go | 261 + cloudstack/cloudstack.go | 2 +- generate/generate.go | 60 +- generate/layout.go | 9 + generate/listApis.json | 194377 +++++++++++++++-------------- test/QuotaService_test.go | 114 + 7 files changed, 102362 insertions(+), 94170 deletions(-) diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index 9adfe6c4..8770cae6 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -22,11 +22,368 @@ package cloudstack import ( "encoding/json" "net/url" + "strconv" ) type QuotaServiceIface interface { + QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) + NewQuotaBalanceParams(account string, domainid string) *QuotaBalanceParams + QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsResponse, error) + NewQuotaCreditsParams(account string, domainid string, value float64) *QuotaCreditsParams QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) NewQuotaIsEnabledParams() *QuotaIsEnabledParams + QuotaStatement(p *QuotaStatementParams) (*QuotaStatementResponse, error) + NewQuotaStatementParams(account string, domainid string, enddate string, startdate string) *QuotaStatementParams + QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) + NewQuotaSummaryParams() *QuotaSummaryParams + QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) + NewQuotaTariffCreateParams(name string, usagetype int, value float64) *QuotaTariffCreateParams + QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTariffDeleteResponse, error) + NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams + QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffListResponse, error) + NewQuotaTariffListParams() *QuotaTariffListParams + QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) + NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams + QuotaUpdate(p *QuotaUpdateParams) (*QuotaUpdateResponse, error) + NewQuotaUpdateParams() *QuotaUpdateParams +} + +type QuotaBalanceParams struct { + p map[string]interface{} +} + +func (p *QuotaBalanceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["accountid"]; found { + u.Set("accountid", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + return u +} + +func (p *QuotaBalanceParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *QuotaBalanceParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *QuotaBalanceParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *QuotaBalanceParams) SetAccountid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountid"] = v +} + +func (p *QuotaBalanceParams) ResetAccountid() { + if p.p != nil && p.p["accountid"] != nil { + delete(p.p, "accountid") + } +} + +func (p *QuotaBalanceParams) GetAccountid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountid"].(string) + return value, ok +} + +func (p *QuotaBalanceParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *QuotaBalanceParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *QuotaBalanceParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *QuotaBalanceParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *QuotaBalanceParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") + } +} + +func (p *QuotaBalanceParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaBalanceParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *QuotaBalanceParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") + } +} + +func (p *QuotaBalanceParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +// You should always use this function to get a new QuotaBalanceParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaBalanceParams(account string, domainid string) *QuotaBalanceParams { + p := &QuotaBalanceParams{} + p.p = make(map[string]interface{}) + p.p["account"] = account + p.p["domainid"] = domainid + return p +} + +// Create a quota balance statement +func (s *QuotaService) QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) { + resp, err := s.cs.newRequest("quotaBalance", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaBalanceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaBalanceResponse struct { + Statement QuotaBalanceResponseType `json:"balance"` +} + +type QuotaBalanceResponseType struct { + StartQuota float64 `json:"startquota"` + Credits []string `json:"credits"` + StartDate string `json:"startdate"` + Currency string `json:"currency"` +} + +type QuotaCreditsParams struct { + p map[string]interface{} +} + +func (p *QuotaCreditsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["min_balance"]; found { + vv := strconv.FormatFloat(v.(float64), 'f', -1, 64) + u.Set("min_balance", vv) + } + if v, found := p.p["quota_enforce"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("quota_enforce", vv) + } + if v, found := p.p["value"]; found { + vv := strconv.FormatFloat(v.(float64), 'f', -1, 64) + u.Set("value", vv) + } + return u +} + +func (p *QuotaCreditsParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *QuotaCreditsParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *QuotaCreditsParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *QuotaCreditsParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *QuotaCreditsParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *QuotaCreditsParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *QuotaCreditsParams) SetMin_balance(v float64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["min_balance"] = v +} + +func (p *QuotaCreditsParams) ResetMin_balance() { + if p.p != nil && p.p["min_balance"] != nil { + delete(p.p, "min_balance") + } +} + +func (p *QuotaCreditsParams) GetMin_balance() (float64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["min_balance"].(float64) + return value, ok +} + +func (p *QuotaCreditsParams) SetQuota_enforce(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["quota_enforce"] = v +} + +func (p *QuotaCreditsParams) ResetQuota_enforce() { + if p.p != nil && p.p["quota_enforce"] != nil { + delete(p.p, "quota_enforce") + } +} + +func (p *QuotaCreditsParams) GetQuota_enforce() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["quota_enforce"].(bool) + return value, ok +} + +func (p *QuotaCreditsParams) SetValue(v float64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaCreditsParams) ResetValue() { + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") + } +} + +func (p *QuotaCreditsParams) GetValue() (float64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(float64) + return value, ok +} + +// You should always use this function to get a new QuotaCreditsParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaCreditsParams(account string, domainid string, value float64) *QuotaCreditsParams { + p := &QuotaCreditsParams{} + p.p = make(map[string]interface{}) + p.p["account"] = account + p.p["domainid"] = domainid + p.p["value"] = value + return p +} + +// Add +-credits to an account +func (s *QuotaService) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsResponse, error) { + resp, err := s.cs.newRequest("quotaCredits", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaCreditsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaCreditsResponse struct { + Credits float64 `json:"credits"` + Currency string `json:"currency"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Updated_by string `json:"updated_by"` + Updated_on string `json:"updated_on"` } type QuotaIsEnabledParams struct { @@ -69,3 +426,1355 @@ type QuotaIsEnabledResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` } + +type QuotaStatementParams struct { + p map[string]interface{} +} + +func (p *QuotaStatementParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["accountid"]; found { + u.Set("accountid", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + if v, found := p.p["type"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("type", vv) + } + return u +} + +func (p *QuotaStatementParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *QuotaStatementParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *QuotaStatementParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *QuotaStatementParams) SetAccountid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountid"] = v +} + +func (p *QuotaStatementParams) ResetAccountid() { + if p.p != nil && p.p["accountid"] != nil { + delete(p.p, "accountid") + } +} + +func (p *QuotaStatementParams) GetAccountid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountid"].(string) + return value, ok +} + +func (p *QuotaStatementParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *QuotaStatementParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *QuotaStatementParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *QuotaStatementParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *QuotaStatementParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") + } +} + +func (p *QuotaStatementParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaStatementParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *QuotaStatementParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") + } +} + +func (p *QuotaStatementParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +func (p *QuotaStatementParams) SetType(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *QuotaStatementParams) ResetType() { + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") + } +} + +func (p *QuotaStatementParams) GetType() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(int) + return value, ok +} + +// You should always use this function to get a new QuotaStatementParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaStatementParams(account string, domainid string, enddate string, startdate string) *QuotaStatementParams { + p := &QuotaStatementParams{} + p.p = make(map[string]interface{}) + p.p["account"] = account + p.p["domainid"] = domainid + p.p["enddate"] = enddate + p.p["startdate"] = startdate + return p +} + +// Create a quota statement +func (s *QuotaService) QuotaStatement(p *QuotaStatementParams) (*QuotaStatementResponse, error) { + resp, err := s.cs.newRequest("quotaStatement", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaStatementResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaStatementResponse struct { + Statement QuotaStatementResponseType `json:"statement"` +} + +type QuotaStatementResponseType struct { + QuotaUsage []QuotaUsage `json:"quotausage"` + TotalQuota float64 `json:"totalquota"` + StartDate string `json:"startdate"` + EndDate string `json:"enddate"` + Currency string `json:"currency"` +} + +type QuotaUsage struct { + Type int `json:"type"` + Accountid int `json:"accountid"` + Domain int `json:"domain"` + Name string `json:"name"` + Unit string `json:"unit"` + Quota float64 `json:"quota"` +} + +type QuotaSummaryParams struct { + p map[string]interface{} +} + +func (p *QuotaSummaryParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + return u +} + +func (p *QuotaSummaryParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *QuotaSummaryParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *QuotaSummaryParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *QuotaSummaryParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *QuotaSummaryParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *QuotaSummaryParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *QuotaSummaryParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *QuotaSummaryParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *QuotaSummaryParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *QuotaSummaryParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *QuotaSummaryParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *QuotaSummaryParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *QuotaSummaryParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *QuotaSummaryParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *QuotaSummaryParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *QuotaSummaryParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *QuotaSummaryParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *QuotaSummaryParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +// You should always use this function to get a new QuotaSummaryParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaSummaryParams() *QuotaSummaryParams { + p := &QuotaSummaryParams{} + p.p = make(map[string]interface{}) + return p +} + +// Lists balance and quota usage for all accounts +func (s *QuotaService) QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) { + resp, err := s.cs.newRequest("quotaSummary", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaSummaryResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaSummaryResponse struct { + Count int `json:"count"` + QuotaSummary []*QuotaSummary `json:"summary"` +} + +type QuotaSummary struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Balance float64 `json:"balance"` + Currency string `json:"currency"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Enddate string `json:"enddate"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Quota float64 `json:"quota"` + Quotaenabled bool `json:"quotaenabled"` + Startdate string `json:"startdate"` + State string `json:"state"` +} + +type QuotaTariffCreateParams struct { + p map[string]interface{} +} + +func (p *QuotaTariffCreateParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["activationrule"]; found { + u.Set("activationrule", v.(string)) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["position"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("position", vv) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + if v, found := p.p["usagetype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("usagetype", vv) + } + if v, found := p.p["value"]; found { + vv := strconv.FormatFloat(v.(float64), 'f', -1, 64) + u.Set("value", vv) + } + return u +} + +func (p *QuotaTariffCreateParams) SetActivationrule(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["activationrule"] = v +} + +func (p *QuotaTariffCreateParams) ResetActivationrule() { + if p.p != nil && p.p["activationrule"] != nil { + delete(p.p, "activationrule") + } +} + +func (p *QuotaTariffCreateParams) GetActivationrule() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["activationrule"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *QuotaTariffCreateParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *QuotaTariffCreateParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *QuotaTariffCreateParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") + } +} + +func (p *QuotaTariffCreateParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *QuotaTariffCreateParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *QuotaTariffCreateParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetPosition(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["position"] = v +} + +func (p *QuotaTariffCreateParams) ResetPosition() { + if p.p != nil && p.p["position"] != nil { + delete(p.p, "position") + } +} + +func (p *QuotaTariffCreateParams) GetPosition() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["position"].(int) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *QuotaTariffCreateParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") + } +} + +func (p *QuotaTariffCreateParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetUsagetype(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usagetype"] = v +} + +func (p *QuotaTariffCreateParams) ResetUsagetype() { + if p.p != nil && p.p["usagetype"] != nil { + delete(p.p, "usagetype") + } +} + +func (p *QuotaTariffCreateParams) GetUsagetype() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usagetype"].(int) + return value, ok +} + +func (p *QuotaTariffCreateParams) SetValue(v float64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaTariffCreateParams) ResetValue() { + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") + } +} + +func (p *QuotaTariffCreateParams) GetValue() (float64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(float64) + return value, ok +} + +// You should always use this function to get a new QuotaTariffCreateParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaTariffCreateParams(name string, usagetype int, value float64) *QuotaTariffCreateParams { + p := &QuotaTariffCreateParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + p.p["usagetype"] = usagetype + p.p["value"] = value + return p +} + +// Creates a quota tariff for a resource. +func (s *QuotaService) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) { + resp, err := s.cs.newPostRequest("quotaTariffCreate", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaTariffCreateResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaTariffCreateResponse struct { + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Position int `json:"position"` + Removed string `json:"removed"` + TariffValue float64 `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType int `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` +} + +type QuotaTariffDeleteParams struct { + p map[string]interface{} +} + +func (p *QuotaTariffDeleteParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *QuotaTariffDeleteParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *QuotaTariffDeleteParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *QuotaTariffDeleteParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new QuotaTariffDeleteParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams { + p := &QuotaTariffDeleteParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Marks a quota tariff as removed. +func (s *QuotaService) QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTariffDeleteResponse, error) { + resp, err := s.cs.newRequest("quotaTariffDelete", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaTariffDeleteResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaTariffDeleteResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *QuotaTariffDeleteResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias QuotaTariffDeleteResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type QuotaTariffListParams struct { + p map[string]interface{} +} + +func (p *QuotaTariffListParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["listonlyremoved"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listonlyremoved", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + if v, found := p.p["usagetype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("usagetype", vv) + } + return u +} + +func (p *QuotaTariffListParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *QuotaTariffListParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") + } +} + +func (p *QuotaTariffListParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaTariffListParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *QuotaTariffListParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *QuotaTariffListParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *QuotaTariffListParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *QuotaTariffListParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *QuotaTariffListParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *QuotaTariffListParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *QuotaTariffListParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *QuotaTariffListParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *QuotaTariffListParams) SetListonlyremoved(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listonlyremoved"] = v +} + +func (p *QuotaTariffListParams) ResetListonlyremoved() { + if p.p != nil && p.p["listonlyremoved"] != nil { + delete(p.p, "listonlyremoved") + } +} + +func (p *QuotaTariffListParams) GetListonlyremoved() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listonlyremoved"].(bool) + return value, ok +} + +func (p *QuotaTariffListParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *QuotaTariffListParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *QuotaTariffListParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *QuotaTariffListParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *QuotaTariffListParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *QuotaTariffListParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *QuotaTariffListParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *QuotaTariffListParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *QuotaTariffListParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *QuotaTariffListParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *QuotaTariffListParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") + } +} + +func (p *QuotaTariffListParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +func (p *QuotaTariffListParams) SetUsagetype(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usagetype"] = v +} + +func (p *QuotaTariffListParams) ResetUsagetype() { + if p.p != nil && p.p["usagetype"] != nil { + delete(p.p, "usagetype") + } +} + +func (p *QuotaTariffListParams) GetUsagetype() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usagetype"].(int) + return value, ok +} + +// You should always use this function to get a new QuotaTariffListParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaTariffListParams() *QuotaTariffListParams { + p := &QuotaTariffListParams{} + p.p = make(map[string]interface{}) + return p +} + +// Lists all quota tariff plans +func (s *QuotaService) QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffListResponse, error) { + resp, err := s.cs.newRequest("quotaTariffList", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaTariffListResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaTariffListResponse struct { + Count int `json:"count"` + QuotaTariffList []*QuotaTariffList `json:"quotatariff"` +} + +type QuotaTariffList struct { + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Position int `json:"position"` + Removed string `json:"removed"` + TariffValue float64 `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType int `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` +} + +type QuotaTariffUpdateParams struct { + p map[string]interface{} +} + +func (p *QuotaTariffUpdateParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["activationrule"]; found { + u.Set("activationrule", v.(string)) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["position"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("position", vv) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + if v, found := p.p["usagetype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("usagetype", vv) + } + if v, found := p.p["value"]; found { + vv := strconv.FormatFloat(v.(float64), 'f', -1, 64) + u.Set("value", vv) + } + return u +} + +func (p *QuotaTariffUpdateParams) SetActivationrule(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["activationrule"] = v +} + +func (p *QuotaTariffUpdateParams) ResetActivationrule() { + if p.p != nil && p.p["activationrule"] != nil { + delete(p.p, "activationrule") + } +} + +func (p *QuotaTariffUpdateParams) GetActivationrule() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["activationrule"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *QuotaTariffUpdateParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *QuotaTariffUpdateParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *QuotaTariffUpdateParams) ResetEnddate() { + if p.p != nil && p.p["enddate"] != nil { + delete(p.p, "enddate") + } +} + +func (p *QuotaTariffUpdateParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *QuotaTariffUpdateParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *QuotaTariffUpdateParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetPosition(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["position"] = v +} + +func (p *QuotaTariffUpdateParams) ResetPosition() { + if p.p != nil && p.p["position"] != nil { + delete(p.p, "position") + } +} + +func (p *QuotaTariffUpdateParams) GetPosition() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["position"].(int) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *QuotaTariffUpdateParams) ResetStartdate() { + if p.p != nil && p.p["startdate"] != nil { + delete(p.p, "startdate") + } +} + +func (p *QuotaTariffUpdateParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetUsagetype(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usagetype"] = v +} + +func (p *QuotaTariffUpdateParams) ResetUsagetype() { + if p.p != nil && p.p["usagetype"] != nil { + delete(p.p, "usagetype") + } +} + +func (p *QuotaTariffUpdateParams) GetUsagetype() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usagetype"].(int) + return value, ok +} + +func (p *QuotaTariffUpdateParams) SetValue(v float64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["value"] = v +} + +func (p *QuotaTariffUpdateParams) ResetValue() { + if p.p != nil && p.p["value"] != nil { + delete(p.p, "value") + } +} + +func (p *QuotaTariffUpdateParams) GetValue() (float64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["value"].(float64) + return value, ok +} + +// You should always use this function to get a new QuotaTariffUpdateParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams { + p := &QuotaTariffUpdateParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + return p +} + +// Update the tariff plan for a resource +func (s *QuotaService) QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) { + resp, err := s.cs.newRequest("quotaTariffUpdate", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaTariffUpdateResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaTariffUpdateResponse struct { + ActivationRule string `json:"activationRule"` + Currency string `json:"currency"` + Description string `json:"description"` + EffectiveDate string `json:"effectiveDate"` + EndDate string `json:"endDate"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Position int `json:"position"` + Removed string `json:"removed"` + TariffValue float64 `json:"tariffValue"` + UsageDiscriminator string `json:"usageDiscriminator"` + UsageName string `json:"usageName"` + UsageType int `json:"usageType"` + UsageTypeDescription string `json:"usageTypeDescription"` + UsageUnit string `json:"usageUnit"` +} + +type QuotaUpdateParams struct { + p map[string]interface{} +} + +func (p *QuotaUpdateParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + return u +} + +// You should always use this function to get a new QuotaUpdateParams instance, +// as then you are sure you have configured all required params +func (s *QuotaService) NewQuotaUpdateParams() *QuotaUpdateParams { + p := &QuotaUpdateParams{} + p.p = make(map[string]interface{}) + return p +} + +// Update quota calculations, alerts and statements +func (s *QuotaService) QuotaUpdate(p *QuotaUpdateParams) (*QuotaUpdateResponse, error) { + resp, err := s.cs.newRequest("quotaUpdate", p.toURLValues()) + if err != nil { + return nil, err + } + + var r QuotaUpdateResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type QuotaUpdateResponse struct { + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Updated_on string `json:"updated_on"` +} diff --git a/cloudstack/QuotaService_mock.go b/cloudstack/QuotaService_mock.go index dc1c06f7..a5ba3c18 100644 --- a/cloudstack/QuotaService_mock.go +++ b/cloudstack/QuotaService_mock.go @@ -58,6 +58,34 @@ func (m *MockQuotaServiceIface) EXPECT() *MockQuotaServiceIfaceMockRecorder { return m.recorder } +// NewQuotaBalanceParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaBalanceParams(account, domainid string) *QuotaBalanceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaBalanceParams", account, domainid) + ret0, _ := ret[0].(*QuotaBalanceParams) + return ret0 +} + +// NewQuotaBalanceParams indicates an expected call of NewQuotaBalanceParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaBalanceParams(account, domainid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaBalanceParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaBalanceParams), account, domainid) +} + +// NewQuotaCreditsParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaCreditsParams(account, domainid string, value float64) *QuotaCreditsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaCreditsParams", account, domainid, value) + ret0, _ := ret[0].(*QuotaCreditsParams) + return ret0 +} + +// NewQuotaCreditsParams indicates an expected call of NewQuotaCreditsParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaCreditsParams(account, domainid, value any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaCreditsParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaCreditsParams), account, domainid, value) +} + // NewQuotaIsEnabledParams mocks base method. func (m *MockQuotaServiceIface) NewQuotaIsEnabledParams() *QuotaIsEnabledParams { m.ctrl.T.Helper() @@ -72,6 +100,134 @@ func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaIsEnabledParams() *gomock.C return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaIsEnabledParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaIsEnabledParams)) } +// NewQuotaStatementParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaStatementParams(account, domainid, enddate, startdate string) *QuotaStatementParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaStatementParams", account, domainid, enddate, startdate) + ret0, _ := ret[0].(*QuotaStatementParams) + return ret0 +} + +// NewQuotaStatementParams indicates an expected call of NewQuotaStatementParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaStatementParams(account, domainid, enddate, startdate any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaStatementParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaStatementParams), account, domainid, enddate, startdate) +} + +// NewQuotaSummaryParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaSummaryParams() *QuotaSummaryParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaSummaryParams") + ret0, _ := ret[0].(*QuotaSummaryParams) + return ret0 +} + +// NewQuotaSummaryParams indicates an expected call of NewQuotaSummaryParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaSummaryParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaSummaryParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaSummaryParams)) +} + +// NewQuotaTariffCreateParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaTariffCreateParams(name string, usagetype int, value float64) *QuotaTariffCreateParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaTariffCreateParams", name, usagetype, value) + ret0, _ := ret[0].(*QuotaTariffCreateParams) + return ret0 +} + +// NewQuotaTariffCreateParams indicates an expected call of NewQuotaTariffCreateParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaTariffCreateParams(name, usagetype, value any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaTariffCreateParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaTariffCreateParams), name, usagetype, value) +} + +// NewQuotaTariffDeleteParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaTariffDeleteParams(id string) *QuotaTariffDeleteParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaTariffDeleteParams", id) + ret0, _ := ret[0].(*QuotaTariffDeleteParams) + return ret0 +} + +// NewQuotaTariffDeleteParams indicates an expected call of NewQuotaTariffDeleteParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaTariffDeleteParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaTariffDeleteParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaTariffDeleteParams), id) +} + +// NewQuotaTariffListParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaTariffListParams() *QuotaTariffListParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaTariffListParams") + ret0, _ := ret[0].(*QuotaTariffListParams) + return ret0 +} + +// NewQuotaTariffListParams indicates an expected call of NewQuotaTariffListParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaTariffListParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaTariffListParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaTariffListParams)) +} + +// NewQuotaTariffUpdateParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaTariffUpdateParams(name string) *QuotaTariffUpdateParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaTariffUpdateParams", name) + ret0, _ := ret[0].(*QuotaTariffUpdateParams) + return ret0 +} + +// NewQuotaTariffUpdateParams indicates an expected call of NewQuotaTariffUpdateParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaTariffUpdateParams(name any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaTariffUpdateParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaTariffUpdateParams), name) +} + +// NewQuotaUpdateParams mocks base method. +func (m *MockQuotaServiceIface) NewQuotaUpdateParams() *QuotaUpdateParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewQuotaUpdateParams") + ret0, _ := ret[0].(*QuotaUpdateParams) + return ret0 +} + +// NewQuotaUpdateParams indicates an expected call of NewQuotaUpdateParams. +func (mr *MockQuotaServiceIfaceMockRecorder) NewQuotaUpdateParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewQuotaUpdateParams", reflect.TypeOf((*MockQuotaServiceIface)(nil).NewQuotaUpdateParams)) +} + +// QuotaBalance mocks base method. +func (m *MockQuotaServiceIface) QuotaBalance(p *QuotaBalanceParams) (*QuotaBalanceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaBalance", p) + ret0, _ := ret[0].(*QuotaBalanceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaBalance indicates an expected call of QuotaBalance. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaBalance(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaBalance", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaBalance), p) +} + +// QuotaCredits mocks base method. +func (m *MockQuotaServiceIface) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaCredits", p) + ret0, _ := ret[0].(*QuotaCreditsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaCredits indicates an expected call of QuotaCredits. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaCredits(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaCredits", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaCredits), p) +} + // QuotaIsEnabled mocks base method. func (m *MockQuotaServiceIface) QuotaIsEnabled(p *QuotaIsEnabledParams) (*QuotaIsEnabledResponse, error) { m.ctrl.T.Helper() @@ -86,3 +242,108 @@ func (mr *MockQuotaServiceIfaceMockRecorder) QuotaIsEnabled(p any) *gomock.Call mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaIsEnabled", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaIsEnabled), p) } + +// QuotaStatement mocks base method. +func (m *MockQuotaServiceIface) QuotaStatement(p *QuotaStatementParams) (*QuotaStatementResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaStatement", p) + ret0, _ := ret[0].(*QuotaStatementResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaStatement indicates an expected call of QuotaStatement. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaStatement(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaStatement", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaStatement), p) +} + +// QuotaSummary mocks base method. +func (m *MockQuotaServiceIface) QuotaSummary(p *QuotaSummaryParams) (*QuotaSummaryResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaSummary", p) + ret0, _ := ret[0].(*QuotaSummaryResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaSummary indicates an expected call of QuotaSummary. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaSummary(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaSummary", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaSummary), p) +} + +// QuotaTariffCreate mocks base method. +func (m *MockQuotaServiceIface) QuotaTariffCreate(p *QuotaTariffCreateParams) (*QuotaTariffCreateResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaTariffCreate", p) + ret0, _ := ret[0].(*QuotaTariffCreateResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaTariffCreate indicates an expected call of QuotaTariffCreate. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaTariffCreate(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaTariffCreate", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaTariffCreate), p) +} + +// QuotaTariffDelete mocks base method. +func (m *MockQuotaServiceIface) QuotaTariffDelete(p *QuotaTariffDeleteParams) (*QuotaTariffDeleteResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaTariffDelete", p) + ret0, _ := ret[0].(*QuotaTariffDeleteResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaTariffDelete indicates an expected call of QuotaTariffDelete. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaTariffDelete(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaTariffDelete", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaTariffDelete), p) +} + +// QuotaTariffList mocks base method. +func (m *MockQuotaServiceIface) QuotaTariffList(p *QuotaTariffListParams) (*QuotaTariffListResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaTariffList", p) + ret0, _ := ret[0].(*QuotaTariffListResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaTariffList indicates an expected call of QuotaTariffList. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaTariffList(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaTariffList", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaTariffList), p) +} + +// QuotaTariffUpdate mocks base method. +func (m *MockQuotaServiceIface) QuotaTariffUpdate(p *QuotaTariffUpdateParams) (*QuotaTariffUpdateResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaTariffUpdate", p) + ret0, _ := ret[0].(*QuotaTariffUpdateResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaTariffUpdate indicates an expected call of QuotaTariffUpdate. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaTariffUpdate(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaTariffUpdate", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaTariffUpdate), p) +} + +// QuotaUpdate mocks base method. +func (m *MockQuotaServiceIface) QuotaUpdate(p *QuotaUpdateParams) (*QuotaUpdateResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "QuotaUpdate", p) + ret0, _ := ret[0].(*QuotaUpdateResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// QuotaUpdate indicates an expected call of QuotaUpdate. +func (mr *MockQuotaServiceIfaceMockRecorder) QuotaUpdate(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "QuotaUpdate", reflect.TypeOf((*MockQuotaServiceIface)(nil).QuotaUpdate), p) +} diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index 56fcfe09..bae9bb31 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -39,7 +39,7 @@ import ( "strings" "time" - "go.uber.org/mock/gomock" + gomock "go.uber.org/mock/gomock" ) // UnlimitedResourceID is a special ID to define an unlimited resource diff --git a/generate/generate.go b/generate/generate.go index 0aa09e48..1269bec9 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -71,6 +71,7 @@ var requiresPostMethod = map[string]bool{ "registerUserData": true, "setupUserTwoFactorAuthentication": true, "validateUserTwoFactorAuthenticationCode": true, + "quotaTariffCreate": true, } var mapRequireList = map[string]map[string]bool{ @@ -1177,7 +1178,7 @@ func (s *service) generateAPITest(a *API) { } pn(")") idPresent := false - if !(strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration") { + if !(strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration" || a.Name == "quotaTariffList") { for _, ap := range a.Response { if ap.Name == "id" && ap.Type == "string" { pn(" r, err := client.%s.%s(p)", strings.TrimSuffix(s.name, "Service"), capitalize(a.Name)) @@ -1340,6 +1341,9 @@ func (s *service) generateConvertCode(cmd, name, typ string) { case "int64": pn("vv := strconv.FormatInt(v.(int64), 10)") pn("u.Set(\"%s\", vv)", name) + case "float64": + pn("vv := strconv.FormatFloat(v.(float64), 'f', -1, 64)") + pn("u.Set(\"%s\", vv)", name) case "bool": pn("vv := strconv.FormatBool(v.(bool))") pn("u.Set(\"%s\", vv)", name) @@ -1896,12 +1900,54 @@ func isSuccessOnlyResponse(resp APIResponses) bool { func (s *service) generateResponseType(a *API) { pn := s.pn tn := capitalize(strings.TrimPrefix(a.Name, "configure") + "Response") + + // add custom response types for some specific API calls + if a.Name == "quotaBalance" { + pn("type QuotaBalanceResponse struct {") + pn(" Statement QuotaBalanceResponseType `json:\"balance\"`") + pn("}") + pn("") + pn("type QuotaBalanceResponseType struct {") + pn(" StartQuota float64 `json:\"startquota\"`") + pn(" Credits []string `json:\"credits\"`") + pn(" StartDate string `json:\"startdate\"`") + pn(" Currency string `json:\"currency\"`") + pn("}") + pn("") + return + } + if a.Name == "quotaStatement" { + pn("type QuotaStatementResponse struct {") + pn(" Statement QuotaStatementResponseType `json:\"statement\"`") + pn("}") + pn("") + pn("type QuotaStatementResponseType struct {") + pn(" QuotaUsage []QuotaUsage `json:\"quotausage\"`") + pn(" TotalQuota float64 `json:\"totalquota\"`") + pn(" StartDate string `json:\"startdate\"`") + pn(" EndDate string `json:\"enddate\"`") + pn(" Currency string `json:\"currency\"`") + pn("}") + pn("") + pn("type QuotaUsage struct {") + pn(" Type int `json:\"type\"`") + pn(" Accountid int `json:\"accountid\"`") + pn(" Domain int `json:\"domain\"`") + pn(" Name string `json:\"name\"`") + pn(" Unit string `json:\"unit\"`") + pn(" Quota float64 `json:\"quota\"`") + pn("}") + pn("") + return + } + ln := capitalize(strings.TrimPrefix(a.Name, "list")) // If this is a 'list' response, we need an separate list struct. There seem to be other // types of responses that also need a separate list struct, so checking on exact matches // for those once. - if strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration" || a.Name == "registerUserData" { + if strings.HasPrefix(a.Name, "list") || a.Name == "registerTemplate" || a.Name == "findHostsForMigration" || a.Name == "registerUserData" || + a.Name == "quotaBalance" || a.Name == "quotaSummary" || a.Name == "quotaTariffList" { pn("type %s struct {", tn) // This nasty check is for some specific response that do not behave consistent @@ -1977,6 +2023,14 @@ func (s *service) generateResponseType(a *API) { case "listStoragePoolsMetrics": pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "storagepool") + case "quotaTariffList": + pn(" Count int `json:\"count\"`") + pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "quotatariff") + case "quotaBalance": + pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "balance") + case "quotaSummary": + pn(" Count int `json:\"count\"`") + pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), "summary") default: pn(" Count int `json:\"count\"`") pn(" %s []*%s `json:\"%s\"`", ln, parseSingular(ln), strings.ToLower(parseSingular(ln))) @@ -2240,7 +2294,7 @@ func mapType(aName string, pName string, pType string) string { return "int" case "long": return "int64" - case "float", "double": + case "float", "double", "bigdecimal": return "float64" case "list": if pName == "downloaddetails" || pName == "owner" { diff --git a/generate/layout.go b/generate/layout.go index d399ba93..a878a67a 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -579,7 +579,16 @@ var layout = apiInfo{ "updateSecurityGroup", }, "QuotaService": { + "quotaBalance", + "quotaCredits", "quotaIsEnabled", + "quotaStatement", + "quotaSummary", + "quotaTariffCreate", + "quotaTariffDelete", + "quotaTariffList", + "quotaTariffUpdate", + "quotaUpdate", }, "PodService": { "createManagementNetworkIpRange", diff --git a/generate/listApis.json b/generate/listApis.json index 90ae158d..7bd79154 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -1,93 +1,24 @@ { "api": [ - { - "description": "Lists the resource icon for the specified resource(s)", - "isasync": false, - "name": "listResourceIcon", - "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, - { - "description": "type of the resource", - "length": 255, - "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": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" - }, - {}, - { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.16.0.0" - }, { "description": "Creates VPC offering", "isasync": true, "name": "createVPCOffering", "params": [ { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "the ID of the service offering for the VPC router appliance", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "serviceproviderlist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "servicecapabilitylist", + "name": "fornsx", "required": false, - "since": "4.4", - "type": "map" + "since": "4.20.0", + "type": "boolean" }, { "description": "the ID of the containing domain(s), null for public offerings", @@ -98,34 +29,35 @@ "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 ID of the containing zone(s), null for public offerings", "length": 255, - "name": "serviceproviderlist", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" + "since": "4.13", + "type": "list" }, { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "nsxsupportlb", + "name": "networkmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "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": "routingmode", + "name": "internetprotocol", "required": false, - "since": "4.20.0", + "since": "4.17.0", "type": "string" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, - "name": "networkmode", + "name": "displaytext", "required": false, - "since": "4.20.0", "type": "string" }, { @@ -135,6 +67,14 @@ "required": false, "type": "list" }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, { "description": "true if the VPC offering supports choosing AS number", "length": 255, @@ -144,63 +84,71 @@ "type": "boolean" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "the ID of the service offering for the VPC router appliance", "length": 255, - "name": "displaytext", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the vpc offering", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "fornsx", + "name": "routingmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "servicecapabilitylist", "required": false, - "since": "4.13", - "type": "list" + "since": "4.4", + "type": "map" + }, + { + "description": "the name of the vpc offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the id of the vpc offering", @@ -208,61 +156,44 @@ "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the name of the vpc offering", + "name": "name", + "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", @@ -273,45 +204,50 @@ "type": "boolean" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -320,8 +256,8 @@ "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -330,387 +266,289 @@ ], "type": "list" }, + {}, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "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": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "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": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" } ] }, { - "description": "Creates a new Pod.", + "description": "Creates an account from an LDAP user", "isasync": false, - "name": "createPod", + "name": "ldapCreateAccount", "params": [ { - "description": "the gateway for the Pod", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "gateway", + "name": "timezone", "required": false, "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, "type": "uuid" }, { - "description": "the starting IP address for the Pod", + "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": "startip", + "name": "account", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "name", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { - "description": "Allocation state of this Pod for allocation of new resources", + "description": "Network domain for the account's networks", "length": 255, - "name": "allocationstate", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "the netmask for the Pod", + "description": "details for account used to store specific parameters", "length": 255, - "name": "netmask", + "name": "accountdetails", "required": false, + "type": "map" + }, + { + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "endip", + "name": "accounttype", + "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": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", "required": false, "type": "string" } ], - "related": "listPods,updatePod,createManagementNetworkIpRange", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "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 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": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - } - ], - "type": "list" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "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 total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - } - ], - "type": "list" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, - {}, { - "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 total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, + {}, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - } - ] - }, - { - "description": "Creates an account from an LDAP user", - "isasync": false, - "name": "ldapCreateAccount", - "params": [ + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "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": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "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 list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "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 number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, { "description": "the total number of public ip addresses available for this account to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { @@ -719,53 +557,58 @@ "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "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": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 the account can own", - "name": "projectlimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { @@ -774,128 +617,109 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, + {}, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "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 snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "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 total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the ID of the role", - "name": "roleid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the name of the role", + "name": "rolename", "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 date and time the user account was created", @@ -903,24 +727,24 @@ "type": "date" }, { - "description": "the user state", - "name": "state", + "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", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { "description": "the account type of the user", @@ -928,91 +752,119 @@ "type": "integer" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ], "type": "list" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Copies an iso from one zone to another.", + "isasync": true, + "name": "copyIso", + "params": [ { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "Template ID.", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "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 total memory (in MB) owned by account", - "name": "memorytotal", - "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" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "ID of the zone the template is being copied to.", + "length": 255, + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "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" }, { @@ -1021,188 +873,135 @@ "type": "integer" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "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 owned by account", - "name": "cputotal", - "type": "long" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "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 this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 format of the template.", + "name": "format", + "type": "imageformat" }, - {} - ], - "since": "4.6.0" - }, - { - "description": "Copies an iso from one zone to another.", - "isasync": true, - "name": "copyIso", - "params": [ { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "description": "the template ID", + "name": "id", + "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.", - "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the template display text", - "name": "displaytext", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { "description": "the name of the OS type for this template.", @@ -1210,69 +1009,131 @@ "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "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 format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "the name of the zone for this template", @@ -1280,9 +1141,14 @@ "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "Lists the download progress of a template across all secondary storages", @@ -1290,18 +1156,24 @@ "type": "list" }, { - "description": "the project name of the template", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { @@ -1310,305 +1182,332 @@ "type": "boolean" }, { - "description": "the template name", - "name": "name", - "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" - }, + } + ] + }, + { + "description": "Deletes a autoscale vm profile.", + "isasync": true, + "name": "deleteAutoScaleVmProfile", + "params": [ + { + "description": "the ID of the autoscale profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of the storage policy", + "length": 255, + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", + "required": false, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "response": [ + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, + {}, { - "description": "the template ID", - "name": "id", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the ID of the zone for this template", + "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date this template was created", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "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": "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Storage provider for this pool", + "name": "provider", + "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 Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" } ] }, { - "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "description": "Reboots a system VM.", "isasync": true, - "name": "provisionCertificate", + "name": "rebootSystemVm", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "The ID of the system virtual machine", "length": 255, - "name": "provider", - "required": false, - "type": "string" + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" }, { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "description": "Force reboot the system VM (System VM is Stopped and then Started)", "length": 255, - "name": "reconnect", + "name": "forced", "required": false, + "since": "4.16.0", "type": "boolean" - }, - { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": true, - "type": "uuid" } ], + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", + "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", + "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 operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Deletes a autoscale vm profile.", - "isasync": true, - "name": "deleteAutoScaleVmProfile", - "params": [ { - "description": "the ID of the autoscale profile", - "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { @@ -1617,287 +1516,210 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists VM metrics", - "isasync": false, - "name": "listVirtualMachinesMetrics", - "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": "the link local IP address for the system vm", + "name": "linklocalip", + "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 public netmask for the system VM", + "name": "publicnetmask", + "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 agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, + "description": "the ID of the system VM", + "name": "id", "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 hostname for the system VM", + "name": "hostname", + "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 name for the system VM", + "name": "zonename", + "type": "string" }, { - "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 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, - "type": "boolean" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, + {}, { - "description": "the host ID", - "length": 255, + "description": "the host ID for the system VM", "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the template name for the system VM", + "name": "templatename", + "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, - "name": "state", - "required": false, + "description": "the systemvm agent version", + "name": "version", "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 first DNS for the system VM", + "name": "dns1", + "type": "string" }, + {}, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "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 system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "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 Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + } + ] + }, + { + "description": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "accumulate", + "name": "keyword", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "string" }, { - "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": "boolean" + "type": "integer" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by the service offering", + "description": "the ID of the Zone", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "list dedicated zones by affinity group", "length": 255, "name": "affinitygroupid", "related": "createAffinityGroup,listAffinityGroups", @@ -1905,2188 +1727,2168 @@ "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the name of the account associated with the zone. Must be used with domainId.", "length": 255, - "name": "haenable", + "name": "account", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" - }, + } + ], + "related": "dedicateZone", + "response": [ { - "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 Name of the Zone", + "name": "zonename", + "type": "string" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" - } - ], - "related": "listVirtualMachinesMetrics", - "response": [ - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "the ID of the dedicated resource", + "name": "id", "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 Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, + {} + ] + }, + { + "description": "Lists the pools of elastistor", + "isasync": false, + "name": "listElastistorPool", + "params": [ { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 name of the security group", - "name": "name", - "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 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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" - }, - { - "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 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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - } - ], - "type": "set" - }, + "description": "the ID of the Pool", + "length": 255, + "name": "id", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the storage pool", + "name": "name", "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the current available space of the pool", + "name": "size", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "default gateway of the pool", + "name": "gateway", "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 project id of the vm", - "name": "projectid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - {}, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "controller of the pool", + "name": "controllerid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the state of the storage pool", + "name": "state", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, + {}, + {} + ] + }, + { + "description": "Change the BGP peers for a network.", + "isasync": true, + "name": "changeBgpPeersForNetwork", + "params": [ { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "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" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForNetwork,changeBgpPeersForVpc", + "required": false, + "type": "list" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "response": [ + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "AS number of bgp peer", + "name": "asnumber", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "list Tungsten-Fabric LB health monitor", + "isasync": false, + "name": "listTungstenFabricLBHealthMonitor", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "updateTungstenFabricLBHealthMonitor", + "response": [ { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the health monitor expected code", + "name": "expectedcode", "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": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the health monitor type", + "name": "type", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": "the health monitor url path", + "name": "urlpath", "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 health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {} + ] + }, + { + "description": "Deletes account from the project", + "isasync": true, + "name": "deleteAccountFromProject", + "params": [ { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "name of the account to be removed from the project", + "length": 255, + "name": "account", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "Guest vm Boot Type", - "name": "boottype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "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": "id", + "related": "listOsTypes,addGuestOs,updateGuestOs", + "required": true, + "type": "uuid" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, + } + ], + "related": "listOsTypes,addGuestOs", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "is the guest OS visible for the users", + "name": "fordisplay", "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": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the OS type", + "name": "name", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + } + ], + "since": "4.4.0" + }, + { + "description": "Lists all guest vlans", + "isasync": false, + "name": "listGuestVlans", + "params": [ + { + "description": "list guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "list guest vlan by vnet", + "length": 255, + "name": "vnet", + "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": "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the 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 name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "list guest vlan by id", + "length": 255, + "name": "id", + "required": false, + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "list guest vlan by zone", + "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", + "description": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "date the guest VLAN was taken", + "name": "taken", "type": "date" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, { - "description": "network read in MiB", - "name": "networkread", - "type": "string" + "description": "the guest VLAN id", + "name": "id", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the zone ID of the guest VLAN range", + "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 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 account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "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 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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" } - ] + ], + "since": "4.17.0" }, { - "description": "Lists hosts.", + "description": "Updates resource limits for an account or domain.", "isasync": false, - "name": "listHosts", + "name": "updateResourceLimit", "params": [ { - "description": "the state of the host", + "description": "Update resource limits for project", "length": 255, - "name": "state", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "Update resource for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the host", + "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": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "Tag for the resource type", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": " Maximum resource limit.", "length": 255, - "name": "hahost", + "name": "max", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the Zone ID for the host", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "integer" + } + ], + "related": "listResourceLimits", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host type", - "length": 255, - "name": "type", - "required": false, + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", - "length": 255, - "name": "resourcestate", - "required": false, + "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": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": false, - "type": "uuid" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, { - "description": "the id of the host", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", - "required": false, - "type": "uuid" + "description": "The tag for the resource limit", + "name": "tag", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the account of the resource limit", + "name": "account", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the project name of the resource limit", + "name": "project", + "type": "string" }, + {}, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", - "length": 255, - "name": "outofbandmanagementenabled", - "required": false, - "type": "boolean" + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", + "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "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": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, + "name": "id", + "related": "createStaticRoute,listStaticRoutes", + "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum 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" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "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", + "related": "getLoadBalancerSslCertificate", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "key", + "name": "key", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "chain", + "name": "chain", + "type": "string" }, + {}, { "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": "crt", + "name": "crt", "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 incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, + } + ] + }, + { + "description": "Destroys a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "deleteRemoteAccessVpn", + "params": [ { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, + "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": "the name of the host", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ] + }, + { + "description": "Start rolling maintenance", + "isasync": true, + "name": "startRollingMaintenance", + "params": [ { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "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" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the IDs of the hosts to start maintenance on", + "length": 255, + "name": "hostids", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", + "required": false, + "type": "list" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "if rolling mechanism should continue in case of an error", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the command to execute while hosts are on maintenance", + "length": 255, + "name": "payload", + "required": false, "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the IDs of the clusters to start maintenance on", + "length": 255, + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "list" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, + "description": "the IDs of the pods to start maintenance on", + "length": 255, + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the hosts updated", + "name": "hostsupdated", + "response": [ + { + "description": "the ID of the updated host", + "name": "hostid", + "type": "string" + }, + { + "description": "output of the maintenance script on the host", + "name": "output", + "type": "string" + }, + { + "description": "start date of the update on the host", + "name": "startdate", + "type": "string" + }, + { + "description": "end date of the update on the host", + "name": "enddate", + "type": "string" + }, + { + "description": "the name of the updated host", + "name": "hostname", + "type": "string" + } + ], + "type": "list" }, { - "description": "Host details in key/value pairs.", + "description": "in case of failure, details are displayed", "name": "details", - "type": "map" - }, - { - "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": "indicates if the rolling maintenance operation was successful", + "name": "success", "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the hosts skipped", + "name": "hostsskipped", + "response": [ + { + "description": "the reason to skip the host", + "name": "reason", + "type": "string" + }, + { + "description": "the ID of the skipped host", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the skipped host", + "name": "hostname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "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": "list Tungsten-Fabric application policy set", + "isasync": false, + "name": "listTungstenFabricApplicationPolicySet", + "params": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - {}, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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 zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createTungstenFabricApplicationPolicySet", + "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "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": "CPU Arch of the host", - "name": "arch", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" }, { - "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 CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "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": "the Pod name of the host", - "name": "podname", + "description": "Tungsten-Fabric policy name", + "name": "name", "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": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" } ] }, { - "description": "Deletes a storage pool.", - "isasync": false, - "name": "deleteStoragePool", + "description": "Updates network ACL list", + "isasync": true, + "name": "updateNetworkACLList", "params": [ { - "description": "Storage pool id", + "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": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" }, { - "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "forced", + "name": "customid", "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", + "since": "4.4", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the network ACL list", + "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": "Deletes an existing guest network IPv6 prefix.", - "isasync": true, - "name": "deleteGuestNetworkIpv6Prefix", - "params": [ { - "description": "Id of the guest network IPv6 prefix", + "description": "Description of the network ACL list", "length": 255, - "name": "id", - "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {}, + {} ], - "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 Id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - }, - { - "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": "IOPS CloudStack can provision from this storage pool", + "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": "capacityiops", + "name": "rootdisksize", "required": false, + "since": "4.19.1", "type": "long" }, { - "description": "comma-separated list of tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "the URL of the storage pool", + "description": "Virtual Machine ID", "length": 255, - "name": "url", - "required": false, - "since": "4.19.0", - "type": "string" + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "Optional field to expunge old root volume after restore.", "length": 255, - "name": "istagarule", + "name": "expunge", "required": false, + "since": "4.19.1", "type": "boolean" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "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": "enabled", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" - }, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "response": [ - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "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 name of the storage pool", - "name": "zonename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, {}, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the name of the storage pool", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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": "Force reboot the system VM (System VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" - } - ], - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "response": [ + }, { - "description": "the name of the system VM", - "name": "name", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "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.", + "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", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "guest vlan range", - "name": "guestvlan", + "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 link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "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": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the 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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the 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": "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 netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the system VM", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, @@ -4096,177 +3898,300 @@ "type": "integer" }, { - "description": "the ID of the service offering of the system virtual machine.", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" - } - ] - }, - { - "description": "Import LDAP users", - "isasync": false, - "name": "importLdapUsers", - "params": [ + }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", - "length": 255, - "name": "group", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the 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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": " delete a nicira nvp device", + "isasync": true, + "name": "deleteNiciraNvpDevice", + "params": [ + { + "description": "Nicira device ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "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" }, + {}, + { + "description": "any text associated 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 ucs blades", + "isasync": false, + "name": "listUcsBlades", + "params": [ + { + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], - "related": "searchLdap,listLdapUsers", + "related": "associateUcsProfileToBlade", "response": [ + { + "description": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "ucs blade id", + "name": "id", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" + } + ] + }, + { + "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", + "isasync": true, + "name": "notifyBaremetalProvisionDone", + "params": [ + { + "description": "mac of the nic used for provision", + "length": 255, + "name": "mac", + "required": true, + "type": "object" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -4276,116 +4201,219 @@ "type": "integer" }, { - "description": "The user's username", - "name": "username", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Get Volume Snapshot Details", + "isasync": false, + "name": "getVolumeSnapshotDetails", + "params": [ { - "description": "The user's domain", - "name": "domain", + "description": "CloudStack Snapshot UUID", + "length": 255, + "name": "snapshotid", + "required": true, "type": "string" } ], - "since": "4.3.0" + "related": "getVolumeiScsiName", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] }, { - "description": "Moves a domain and its children to a new parent domain.", + "description": "Updates a host.", "isasync": false, - "name": "moveDomain", + "name": "updateHost", "params": [ { - "description": "The ID of the domain to be moved.", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "allocationstate", + "required": false, + "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 host to update", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": true, "type": "uuid" }, { - "description": "The ID of the new parent domain of the domain to be moved.", + "description": "Add an annotation to this host", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": true, + "name": "annotation", + "required": false, + "since": "4.11", + "type": "string" + }, + { + "description": "the new uri for the secondary storage: nfs://host/path", + "length": 255, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + }, + { + "description": "Change the name of host", + "length": 255, + "name": "name", + "required": false, + "since": "4.15", + "type": "string" + }, + { + "description": "the id of Os category to update the host with", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, "type": "uuid" } ], - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the path of the domain", - "name": "path", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "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 ID of the host", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the 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 current status of the latest async job acting on this object", @@ -4393,1008 +4421,1581 @@ "type": "integer" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" + }, + {}, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "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", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 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 secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, - {}, - {}, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "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 domain", - "name": "secondarystorageavailable", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + {}, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the state of the domain", - "name": "state", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" } - ], - "since": "4.19.0.0" + ] }, { - "description": "Lists all available networks.", - "isasync": false, - "name": "listNetworks", + "description": "Creates a egress firewall rule for a given network ", + "isasync": true, + "name": "createEgressFirewallRule", "params": [ { - "description": "list networks by restartRequired", + "description": "the starting port of firewall rule", "length": 255, - "name": "restartrequired", + "name": "startport", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ending port of firewall rule", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "list networks by network offering ID", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "destcidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the zone ID of the network", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "type of firewallrule: system/user", "length": 255, - "name": "isrecursive", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list networks available for VM deployment", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "canusefordeploy", - "required": false, - "type": "boolean" + "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": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "listall", + "name": "cidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "specifyipranges", - "required": false, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", "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 protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", - "length": 255, - "name": "type", - "required": false, + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + {}, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "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": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "flag to display the resource icon for networks", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, + {}, { - "description": "list networks supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], "type": "list" }, { - "description": "List by keyword", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + } + ] + }, + { + "description": "Lists security groups", + "isasync": false, + "name": "listSecurityGroups", + "params": [ + { + "description": "lists security groups by virtual machine id", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list networks by ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "lists security groups by name", "length": 255, - "name": "acltype", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID or VID of the network", + "description": "List by keyword", "length": 255, - "name": "vlan", + "name": "keyword", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "type of the traffic", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "traffictype", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List networks by VPC", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "true if network is system, false otherwise", + "description": "list the security group by the id provided", "length": 255, - "name": "issystem", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list networks by physical network id", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createSecurityGroup,updateSecurityGroup", "response": [ { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the list of services", - "name": "service", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the list of capabilities", - "name": "capability", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the capability value", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", "name": "value", "type": "string" }, { - "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the service provider name", - "name": "provider", + "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the provider name", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], - "type": "list" + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "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": "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", "type": "set" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Enables a role", + "isasync": false, + "name": "enableRole", + "params": [ { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "List OAuth providers registered", + "isasync": false, + "name": "listOauthProvider", + "params": [ { - "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": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the ID of the OAuth provider", + "length": 255, + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "required": false, + "type": "uuid" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", + "response": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "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": "Description of the provider registered", + "name": "description", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Delete Service Package", + "isasync": false, + "name": "deleteServicePackageOffering", + "params": [ + { + "description": "the service offering ID", + "length": 255, + "name": "id", + "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "required": true, "type": "string" - }, + } + ], + "response": [ + {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Update a Shared FileSystem", + "isasync": false, + "name": "updateSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the description for the shared filesystem.", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the shared filesystem.", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the network", - "name": "name", - "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 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 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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "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": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "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 bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "state of the network", - "name": "state", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "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 list of resource tags associated with network", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "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": "the project id the tag belongs to", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "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": "resource type", - "name": "resourcetype", + "description": "the type of the nic", + "name": "type", + "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" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the 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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the 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": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "List dedicated zones.", - "isasync": false, - "name": "listDedicatedZones", - "params": [ - { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list dedicated zones by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "the name of the account associated with the zone. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "dedicateZone", - "response": [ - { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { @@ -5403,512 +6004,391 @@ "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, - {}, { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Lists the pools of elastistor", - "isasync": false, - "name": "listElastistorPool", + "description": "Updates an existing IPv4 subnet for a zone.", + "isasync": true, + "name": "updateIpv4SubnetForZone", "params": [ { - "description": "the ID of the Pool", + "description": "The new CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, + "type": "string" + }, + { + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "required": false, - "type": "long" + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ { - "description": "the current available space of the pool", - "name": "size", - "type": "long" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" }, + {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the state of the storage pool", - "name": "state", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, - {}, { - "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": "controller of the pool", - "name": "controllerid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Releases an IP address from the account.", - "isasync": false, - "name": "releaseIpAddress", + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", "params": [ { - "description": "the ID of the public IP address to release", + "description": "The ID of the system virtual machine", "length": 255, "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" } ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "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" - } - ], - "since": "4.17" - }, - { - "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", - "isasync": true, - "name": "updatePodManagementNetworkIpRange", - "params": [ + }, { - "description": "The current starting IP address.", - "length": 255, - "name": "currentstartip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "The current ending IP address.", - "length": 255, - "name": "currentendip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "The new ending IP address.", - "length": 255, - "name": "newendip", - "required": false, + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "The new starting IP address.", - "length": 255, - "name": "newstartip", - "required": false, + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" - } - ], - "response": [ + }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the 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": "guest vlan range", + "name": "guestvlan", "type": "string" }, - {} - ], - "since": "4.16.0.0" - }, - { - "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, + "description": "public vlan range", + "name": "publicvlan", "type": "list" }, { - "description": "UUID of the network which the Bgp Peers are associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "response": [ + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "name of zone to which the bgp peer belongs to.", + "description": "the Zone name for the system VM", "name": "zonename", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "date when this bgp peer was created.", + "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" - }, - { - "description": "the account of the bgp peer", - "name": "account", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "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 domain ID of the bgp peer", - "name": "domainid", + "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", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, - {}, { - "description": "password of bgp peer", - "name": "password", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Updates firewall rule ", - "isasync": true, - "name": "updateFirewallRule", - "params": [ - { - "description": "the ID of the firewall rule", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - } - ], - "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", - "response": [ - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the firewall rule", + "description": "the ID of the system VM", "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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "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 Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "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 system VM", + "name": "publicip", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the state of the rule", + "description": "the state of the system VM", "name": "state", "type": "string" }, - {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, + {} + ] + }, + { + "description": "Archive one or more events.", + "isasync": false, + "name": "archiveEvents", + "params": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "listEvents", + "required": false, + "type": "list" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "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": "enddate", + "required": false, + "type": "date" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "archive by event type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {} + "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": "startdate", + "required": false, + "type": "date" + } ], - "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -5920,354 +6400,233 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, {} - ], - "since": "4.7.0" + ] }, { - "description": "Deletes the registered OAuth provider", + "description": "List Autonomous Systems Numbers", "isasync": false, - "name": "deleteOauthProvider", + "name": "listASNumbers", "params": [ { - "description": "id of the OAuth provider to be deleted", + "description": "the vpc id", "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", - "required": true, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "AS number", + "length": 255, + "name": "asnumber", + "related": "listASNumbers", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates a Bgp Peer for a zone.", - "isasync": true, - "name": "createBgpPeer", - "params": [ - { - "description": "The AS number of the Bgp Peer.", + "description": "the AS Number range ID", "length": 255, - "name": "asnumber", - "required": true, - "type": "long" + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", + "required": false, + "type": "uuid" }, { - "description": "UUID of the zone which the Bgp Peer belongs to.", + "description": "the zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, "type": "uuid" }, { - "description": "The IPv6 address of the Bgp Peer.", + "description": "", "length": 255, - "name": "ip6address", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "project who will own the Bgp Peer", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isallocated", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "The password of the Bgp Peer.", + "description": "account name", "length": 255, - "name": "password", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "string" }, { - "description": "account who will own the Bgp Peer", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "domain id", "length": 255, - "name": "ipaddress", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "BGP peer details in key/value pairs.", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "the network id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } ], - "related": "listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "related": "", "response": [ { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" - }, - { - "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 domain name of the bgp peer", - "name": "domain", - "type": "string" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "Domain ID", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "AS Number ID", + "name": "asnrangeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "Created Date", + "name": "created", + "type": "date" }, { - "description": "AS number of bgp peer", + "description": "AS Number", "name": "asnumber", "type": "long" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the domain name", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the zone name of the AS Number range", + "name": "zonename", "type": "string" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "VPC ID", + "name": "vpcid", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "Allocated Date", + "name": "allocated", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account name", + "name": "account", + "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "Zone ID", + "name": "zoneid", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Deletes account from the project", - "isasync": true, - "name": "deleteAccountFromProject", - "params": [ - { - "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" }, { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, + "description": "Network Name", + "name": "associatednetworkname", "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": "Account ID", + "name": "accountid", + "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": "AS Number Range", + "name": "asnrange", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Allocation state", + "name": "allocationstate", "type": "string" }, { - "description": "Hypervisor name", - "name": "name", + "description": "ID of the AS Number", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC Name", + "name": "vpcname", + "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Updates the information about Guest OS", - "isasync": true, - "name": "updateGuestOs", + "description": "Deletes a secondary staging store .", + "isasync": false, + "name": "deleteSecondaryStagingStore", "params": [ { - "description": "UUID of the Guest OS", + "description": "the staging store ID", "length": 255, "name": "id", - "related": "listOsTypes,addGuestOs,updateGuestOs", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" - }, - { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, - "type": "string" - }, - { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" } ], - "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the OS type", - "name": "id", - "type": "string" - }, - { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "is the guest OS visible for the users", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "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", @@ -6278,1198 +6637,1160 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the name of the OS type", - "name": "name", - "type": "string" - }, - {}, {} ], - "since": "4.4.0" + "since": "4.2.0" }, { - "description": "Lists all guest vlans", + "description": "List registered userdatas", "isasync": false, - "name": "listGuestVlans", + "name": "listUserData", "params": [ { - "description": "List by keyword", + "description": "Userdata name to look for", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "allocatedonly", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list guest vlan by vnet", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vnet", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "list guest vlan by physical network", + "description": "the ID of the Userdata", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "id", + "related": "listUserData", "required": false, "type": "uuid" }, { - "description": "list guest vlan by zone", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list guest vlan by id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", + "name": "isrecursive", "required": false, - "type": "long" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the project id of the userdata", + "name": "projectid", "type": "string" }, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "Name of the userdata", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the owner id of the userdata", + "name": "accountid", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the domain name of the userdata owner", + "name": "domain", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the guest VLAN", - "name": "vlan", - "type": "string" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "path of the domain to which the userdata owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" - }, - { - "description": "the guest VLAN id", + "description": "ID of the ssh keypair", "name": "id", - "type": "long" + "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the project name of the userdata", + "name": "project", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" - }, - { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "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 project id of the guest VLAN range", - "name": "projectid", + "description": "the owner of the userdata", + "name": "account", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "base64 encoded userdata content", + "name": "userdata", "type": "string" } ], - "since": "4.17.0" + "since": "4.18" }, { - "description": "Updates resource limits for an account or domain.", - "isasync": false, - "name": "updateResourceLimit", + "description": "Updates an internal load balancer", + "isasync": true, + "name": "updateLoadBalancer", "params": [ { - "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.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": " Maximum resource limit.", + "description": "the ID of the load balancer", "length": 255, - "name": "max", - "required": false, - "type": "long" + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": "Update resource limits for project", + "description": "an optional field, whether to the display the rule 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" + } + ], + "related": "createLoadBalancer,listLoadBalancers", + "response": [ + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the description of the Load Balancer", + "name": "description", "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 account of the Load Balancer", + "name": "account", + "type": "string" }, { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" - } - ], - "related": "listResourceLimits", - "response": [ - {}, + }, { - "description": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "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": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "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 resource tags associated with the Load Balancer", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" }, { - "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 name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "The tag for the resource limit", - "name": "tag", - "type": "string" + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.4.0" }, { - "description": "Dedicates an existing Bgp Peer to an account or a domain.", + "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": "dedicateBgpPeer", + "name": "scaleSystemVm", "params": [ { - "description": "account who will own the Bgp Peer", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "project who will own the Bgp Peer", + "description": "The ID of the system vm", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, "type": "uuid" }, { - "description": "domain ID of the account owning the Bgp Peer", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "Id of the Bgp Peer", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "id", - "related": "listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" } ], - "related": "listBgpPeers,updateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "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": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, - {}, { - "description": "id of the bgp peer", - "name": "id", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, - {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - } - ], - "since": "4.20.0" - }, - { - "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists hosts metrics", - "isasync": false, - "name": "listHostsMetrics", - "params": [ { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "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": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": false, - "type": "uuid" - }, - { - "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, + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", - "length": 255, - "name": "resourcestate", - "required": false, + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the state of the host", - "length": 255, + "description": "the state of the system VM", "name": "state", - "required": false, "type": "string" }, { - "description": "the host type", - "length": 255, - "name": "type", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", - "length": 255, - "name": "hahost", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list hosts for which out-of-band management is enabled", - "length": 255, - "name": "outofbandmanagementenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the id of the host", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "lists hosts existing in particular cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the host", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, {}, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", - "type": "string" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "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": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the date and time the system VM was created", + "name": "created", "type": "date" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", + "description": "the last disconnected date of host", "name": "disconnected", "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the ID of the system VM", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Verify the OAuth Code and fetch the corresponding user from provider", + "isasync": false, + "name": "verifyOAuthCodeAndGetUser", + "params": [ { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "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 CPU currently allocated", - "name": "cpuallocated", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + } + ], + "related": "updateOauthProvider", + "response": [ + {}, { - "description": "the ID of the host", + "description": "ID of the provider", "name": "id", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "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": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Name of the provider", + "name": "name", + "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", "type": "boolean" }, { - "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 Pod name of the host", - "name": "podname", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "List DRS plans for a clusters", + "isasync": false, + "name": "listClusterDrsPlan", + "params": [ { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "network read in GiB", - "name": "networkread", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "ID of the drs plan", + "length": 255, + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "required": false, + "type": "uuid" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" + } + ], + "related": "generateClusterDrsPlan,executeClusterDrsPlan", + "response": [ { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "events available for the host", - "name": "events", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, + {}, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, + {}, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "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.19.0" + }, + { + "description": "Lists clusters.", + "isasync": false, + "name": "listClusters", + "params": [ + { + "description": "lists clusters by the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "lists clusters by cluster type", + "length": 255, + "name": "clustertype", + "required": false, "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "lists clusters by hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, "type": "string" }, - {}, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "addCluster,updateCluster", + "response": [ { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "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": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" }, + {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - } - ], - "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,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": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "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 capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" }, - {}, - {}, { - "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 hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" } ] }, { - "description": "Lists affinity groups", + "description": "Lists project invitations and provides detailed information for listed invitations", "isasync": false, - "name": "listAffinityGroups", + "name": "listProjectInvitations", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list the affinity group by the ID provided", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "list invitations by state", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list invitation by user ID", "length": 255, - "name": "pagesize", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists affinity groups by name", + "description": "list by project id", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists affinity groups by type", + "description": "list invitations by id", "length": 255, - "name": "type", + "name": "id", + "related": "listProjectInvitations", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -7479,1643 +7800,1229 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "listall", + "name": "activeonly", "required": false, "type": "boolean" } ], - "related": "createAffinityGroup", + "related": "", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the project", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the project", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the domain ID of the affinity group", + "description": "the domain id the project belongs to", "name": "domainid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "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 project ID of the affinity group", - "name": "projectid", + "description": "the account name of the project's owner", + "name": "account", "type": "string" }, - {}, - {}, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the User ID", + "name": "userid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the invitation", + "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain the project belongs to", "name": "domainpath", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Cancels a triggered shutdown", + "description": "Lists all egress firewall rules for network ID.", "isasync": false, - "name": "cancelShutdown", + "name": "listEgressFirewallRules", "params": [ { - "description": "the uuid of the management server", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, "type": "uuid" - } - ], - "related": "prepareForShutdown,readyForShutdown,triggerShutdown", - "response": [ - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Register a public key in a keypair under a certain name", - "isasync": false, - "name": "registerSSHKeyPair", - "params": [ - { - "description": "an optional account for the ssh key. Must be used with domainId.", + "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" - }, - { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, - "type": "string" + "type": "boolean" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, { - "description": "an optional project for the ssh key", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Name of the keypair", + "description": "List by keyword", "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "listSSHKeyPairs", - "response": [ - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the keypair owner", - "name": "project", + "name": "keyword", + "required": false, "type": "string" }, - {}, - {}, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "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": "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 project id of the keypair owner", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Name of the keypair", - "name": "name", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" - } - ] - }, - { - "description": "Destroys a l2tp/ipsec remote access vpn", - "isasync": true, - "name": "deleteRemoteAccessVpn", - "params": [ - { - "description": "public ip address id of the vpn server", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, "type": "uuid" } ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" - } - ] - }, - { - "description": "Start rolling maintenance", - "isasync": true, - "name": "startRollingMaintenance", - "params": [ - { - "description": "the IDs of the clusters to start maintenance on", - "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "list" }, { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", - "length": 255, - "name": "timeout", - "required": false, + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the IDs of the zones to start maintenance on", - "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" - }, - { - "description": "the IDs of the pods to start maintenance on", - "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "list" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "if rolling mechanism should continue in case of an error", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { - "description": "the IDs of the hosts to start maintenance on", - "length": 255, - "name": "hostids", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", - "required": false, - "type": "list" + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" }, { - "description": "the command to execute while hosts are on maintenance", - "length": 255, - "name": "payload", - "required": false, + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the hosts skipped", - "name": "hostsskipped", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the name of the skipped host", - "name": "hostname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the skipped host", - "name": "hostid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "the account associated with the tag", + "name": "account", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the hosts updated", - "name": "hostsupdated", - "response": [ + }, { - "description": "the ID of the updated host", - "name": "hostid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "end date of the update on the host", - "name": "enddate", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, - {}, { - "description": "in case of failure, details are displayed", - "name": "details", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + {}, + {}, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "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": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + } ] }, { - "description": "Updates network ACL list", - "isasync": true, - "name": "updateNetworkACLList", + "description": "Lists clusters metrics", + "isasync": false, + "name": "listClustersMetrics", "params": [ { - "description": "Name of the network ACL list", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "lists clusters by the cluster name", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "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", + "description": "lists clusters by allocation state", "length": 255, - "name": "customid", + "name": "allocationstate", "required": false, - "since": "4.4", "type": "string" }, { - "description": "Description of the network ACL list", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "description", + "name": "showcapacities", "required": false, - "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "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" - } - ], - "since": "4.4" - }, - { - "description": "Reserve a public IP to an account.", - "isasync": false, - "name": "reserveIpAddress", - "params": [ + }, { - "description": "the ID of the domain to reserve with this IP address", + "description": "lists clusters by Pod ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID of the public IP address to reserve", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "lists clusters by the cluster ID", "length": 255, "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "the ID of the project to reserve with this IP address", + "description": "lists clusters by cluster type", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "clustertype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "fordisplay", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the account to reserve with this IP address", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "account", + "name": "managedstate", "required": false, "type": "string" } ], - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the capacity of the Cluster", + "name": "capacity", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the Cluster name", + "name": "clustername", "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Zone ID", + "name": "zoneid", "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": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "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", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the total cpu used in GiB", + "name": "memoryused", "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": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, - {}, - { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - }, { - "description": "public IP address id", + "description": "the cluster ID", "name": "id", "type": "string" }, + {}, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "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": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, + {}, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "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": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" } ], - "since": "4.17" + "since": "4.9.3" }, { - "description": "Restore a VM to original template/ISO or new template/ISO", - "isasync": true, - "name": "restoreVirtualMachine", + "description": "Lists objects at specified path on a storage pool.", + "isasync": false, + "name": "listStoragePoolObjects", "params": [ { - "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "path to list on storage pool", "length": 255, - "name": "rootdisksize", + "name": "path", "required": false, - "since": "4.19.1", - "type": "long" + "type": "string" }, { - "description": "Override root volume's diskoffering.", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "page", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "integer" }, { - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Optional field to expunge old root volume after restore.", + "description": "List by keyword", "length": 255, - "name": "expunge", + "name": "keyword", "required": false, - "since": "4.19.1", - "type": "boolean" + "type": "string" }, { - "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": "id of the storage pool", "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, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, "type": "uuid" - }, - { - "description": "used to specify the custom parameters", - "length": 255, - "name": "details", - "required": false, - "since": "4.19.1", - "type": "map" } ], - "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", + "related": "listImageStoreObjects", "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Volume Name associated with the data store object.", + "name": "volumename", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "Name of the data store object.", + "name": "name", + "type": "string" + }, + { + "description": "Size is in Bytes.", + "name": "size", "type": "long" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "Is it a directory.", + "name": "isdirectory", "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag 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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "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": "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": "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": "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" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "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" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists secondary staging stores.", + "isasync": false, + "name": "listSecondaryStagingStores", + "params": [ + { + "description": "the name of the staging store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the staging store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the staging store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "response": [ + { + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "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": "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 VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, + "description": "the ID of the image store", + "name": "id", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "startRouter", + "params": [ { - "description": "the project name of the vm", - "name": "project", + "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 gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "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", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host ID for the router", + "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", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the 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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "role of the domain router", + "name": "role", "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -9124,19 +9031,19 @@ "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { "description": "ID of the VLAN/VNI if available", @@ -9144,8 +9051,13 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -9153,35 +9065,30 @@ "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -9189,8 +9096,8 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -9204,311 +9111,199 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "description": "the template ID for the router", "name": "templateid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "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": "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": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" } ], - "type": "set" - }, - { - "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 name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "type": "list" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "the domain associated with the router", "name": "domain", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the Zone ID for the router", + "name": "zoneid", "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": "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" } - ], - "since": "3.0.0" + ] }, { - "description": "Delete one or more events.", + "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": "deleteEvents", + "name": "resetConfiguration", "params": [ { - "description": "delete by event type", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "type", + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the events", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "startdate", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "enddate", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "date" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "uuid" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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", + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, "type": "string" - } - ] - }, - { - "description": " delete a nicira nvp device", - "isasync": true, - "name": "deleteNiciraNvpDevice", - "params": [ + }, { - "description": "Nicira device ID", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" } ], + "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the configuration", + "name": "name", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" + }, + { + "description": "the component of the configuration", + "name": "component", "type": "string" }, { @@ -9518,38 +9313,44 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, - {} - ] - }, - { - "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", - "isasync": true, - "name": "notifyBaremetalProvisionDone", - "params": [ { - "description": "mac of the nic used for provision", - "length": 255, - "name": "mac", - "required": true, - "type": "object" - } - ], - "response": [ - {}, - {}, + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the group of the configuration", + "name": "group", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the configuration", + "name": "description", + "type": "string" + }, + { + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + { + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" + }, + { + "description": "the category of the configuration", + "name": "category", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -9557,58 +9358,108 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the configuration value", + "name": "type", + "type": "string" + }, + { + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + {}, + { + "description": "the value of the configuration", + "name": "value", "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": "List by keyword", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "keyword", + "name": "quiettime", "required": false, + "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" }, { - "description": "ucs manager id", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "conditionids", + "related": "createCondition,listConditions", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "page", - "required": false, + "name": "duration", + "required": true, "type": "integer" }, { - "description": "", + "description": "the name of the autoscale policy", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" } ], - "related": "associateUcsProfileToBlade", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + { + "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": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { @@ -9617,91 +9468,175 @@ "type": "integer" }, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + {}, + { + "description": "name of the autoscale policy", + "name": "name", "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 action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, - {} + { + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" + } ] }, { - "description": "Get Volume Snapshot Details", + "description": "Removes stratosphere ssp server", "isasync": false, - "name": "getVolumeSnapshotDetails", + "name": "deleteStratosphereSsp", "params": [ { - "description": "CloudStack Snapshot UUID", + "description": "the host ID of ssp server", "length": 255, - "name": "snapshotid", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "getVolumeiScsiName", "response": [ {}, - { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation 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 an ISO file.", + "description": "Lists Usage Server metrics", + "isasync": false, + "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": "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 name of the active usage server", + "name": "hostname", + "type": "string" + }, + { + "description": "the state of the usage server", + "name": "state", + "type": "state" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Enables HA for a zone", "isasync": true, - "name": "deleteIso", + "name": "enableHAForZone", "params": [ { - "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, - "type": "uuid" - }, - { - "description": "the ID of the ISO file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "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.11" + }, + { + "description": "Cleanups VM reservations in the database.", + "isasync": true, + "name": "cleanVMReservations", + "params": [], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -9712,539 +9647,476 @@ "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { - "description": "Updates a host.", - "isasync": false, - "name": "updateHost", + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", "params": [ { - "description": "the id of Os category to update the host with", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", "length": 255, - "name": "istagarule", + "name": "fordisplay", "required": false, "type": "boolean" }, { - "description": "Add an annotation to this host", - "length": 255, - "name": "annotation", - "required": false, - "since": "4.11", - "type": "string" - }, - { - "description": "the ID of the host to update", + "description": "the ID of the Routing firewall rule", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" }, { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" - }, - { - "description": "Change the name of host", - "length": 255, - "name": "name", - "required": false, - "since": "4.15", - "type": "string" - }, - { - "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "url", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "response": [ { - "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": "privateendport", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "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" - }, - { - "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, - {}, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "list" }, + {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", + "params": [ + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "required": false, + "type": "uuid" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the name of the object store", + "length": 255, + "name": "name", + "required": false, "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 object store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "addObjectStoragePool,updateObjectStoragePool", + "response": [ + {}, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the name of the object store", + "name": "name", "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total size of the object store", + "name": "storagetotal", "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, - {}, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "create secondary staging store.", + "isasync": false, + "name": "createSecondaryStagingStore", + "params": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the scope of the staging store: zone only for now", + "length": 255, + "name": "scope", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "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 last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the staging store provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the details for the staging store", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "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 Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, + {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, + {} + ] + }, + { + "description": "Remove a VMware datacenter from a zone.", + "isasync": false, + "name": "removeVmwareDc", + "params": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID of the host", + "description": "The id of Zone from which VMware datacenter has to be removed.", + "length": 255, "name": "zoneid", - "type": "string" - }, + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if operation 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": "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 network id of the port forwarding rule", + "description": "ID of load balancer health check policy", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", "required": true, "type": "uuid" }, { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "destcidrlist", - "required": false, - "type": "list" - }, - { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "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, @@ -10252,60 +10124,36 @@ "type": "boolean" }, { - "description": "the cidr list to forward traffic from. 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": "cidrlist", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" } ], - "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "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 traffic type for the firewall rule", - "name": "traffictype", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -10313,385 +10161,459 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "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", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" } ], "type": "list" }, - {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicyRule", + "params": [ + { + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric policy rule", + "length": 255, + "name": "ruleuuid", + "required": true, + "type": "string" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "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": "Lists VPC offerings", - "isasync": false, - "name": "listVPCOfferings", + "description": "Creates a load balancer rule", + "isasync": true, + "name": "createLoadBalancerRule", "params": [ { - "description": "List by keyword", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "keyword", + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "list VPC offerings by name", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "boolean" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "list VPC offerings by display text", + "description": "name of the load balancer rule", "length": 255, - "name": "displaytext", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "pagesize", + "name": "protocol", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "since": "4.18", "type": "uuid" }, { - "description": "", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "id of zone VPC offering is associated with", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" + "name": "publicport", + "required": true, + "type": "integer" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "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": "isdefault", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC offerings by id", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "list VPC offerings supporting certain services", + "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": "supportedservices", + "name": "cidrlist", "required": false, + "since": "4.18.0.0", "type": "list" } ], - "related": "updateVPCOffering", + "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "the public ip address", + "name": "publicip", + "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 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": "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": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" }, {}, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the state of the rule", + "name": "state", "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 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": "tag value", + "name": "value", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "list" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the id of the vpc offering", - "name": "id", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the domain of the load balancer rule", + "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 private port", + "name": "privateport", + "type": "string" }, { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the load balancer rule ID", + "name": "id", "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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" } ] }, { - "description": "Get the SF volume size including Hypervisor Snapshot Reserve", + "description": "List quota email template configurations", "isasync": false, - "name": "getSolidFireVolumeSize", + "name": "quotaListEmailConfiguration", "params": [ { - "description": "Volume UUID", + "description": "Account ID for which to list quota template email configurations", "length": 255, - "name": "volumeid", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "quotaConfigureEmail", "response": [ - {}, { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" + "description": "The template's name.", + "name": "templatename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -10700,85 +10622,86 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The configured account's id.", + "name": "account", "type": "string" + }, + { + "description": "Whether the template is enabled.", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" } - ] + ], + "since": "4.20.0.0" }, { - "description": "Uploads a data disk.", - "isasync": true, - "name": "uploadVolume", + "description": "Import vSphere storage policies", + "isasync": false, + "name": "importVsphereStoragePolicies", "params": [ { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "description": "ID of the zone", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, + } + ], + "related": "listVsphereStoragePolicies", + "response": [ { - "description": "an optional accountName. 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": "Upload volume for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" }, + {}, { - "description": "the name of the volume", - "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": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "Image store uuid", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "the ID of the Zone", + "name": "zoneid", "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 identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, + {}, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the name of the Storage Policy", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Disables out-of-band management for a zone", + "isasync": true, + "name": "disableOutOfBandManagementForZone", + "params": [ { - "description": "the ID of the zone the volume is to be hosted on", + "description": "the ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -10786,186 +10709,203 @@ "type": "uuid" } ], - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "the operation result", + "name": "status", "type": "boolean" }, + {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "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 interface username", + "name": "username", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, + {} + ], + "since": "4.9.0" + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "params": [ { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "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": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "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": "state of the virtual machine", - "name": "vmstate", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "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": "ID of the disk volume", - "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" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "response": [ { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -10974,8 +10914,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -10984,33 +10924,33 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -11019,539 +10959,625 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the path of the volume", - "name": "path", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "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": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the state of the rule", + "name": "state", "type": "string" + } + ] + }, + { + "description": "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": "name of the disk offering", - "name": "diskofferingname", + "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 Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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 bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, + { + "description": "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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "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", "type": "string" }, {}, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" } ] }, { - "description": "Lists security groups", - "isasync": false, - "name": "listSecurityGroups", + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", "params": [ { - "description": "List by keyword", + "description": "the ID of the firewall rule", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "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": "list the security group by the id provided", - "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "required": false, - "type": "uuid" + "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.", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Updates a VPC", + "isasync": true, + "name": "updateVPC", + "params": [ + { + "description": "the display text of the VPC", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, { - "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": "lists security groups by name", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "securitygroupname", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "lists security groups by virtual machine id", + "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": "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", + "name": "sourcenatipaddress", "required": false, - "type": "uuid" + "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": "", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "page", + "name": "publicmtu", "required": false, + "since": "4.18.0", "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the name of the VPC", "length": 255, - "name": "listall", + "name": "name", "required": false, + "type": "string" + } + ], + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the domain id of the VPC owner", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", "type": "integer" - } - ], - "related": "createSecurityGroup,updateSecurityGroup", - "response": [ + }, + {}, {}, { - "description": "the ID of the security group", - "name": "id", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", "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": "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 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 list of resource tags associated with the rule", - "name": "tags", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "tag value", + "description": "the capability value", "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the capability name", + "name": "name", "type": "string" } ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - {}, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "type": "list" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "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": "the list of resource tags associated with the project", "name": "tags", "response": [ { @@ -11560,43 +11586,43 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -11610,330 +11636,372 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the date this VPC 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 VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the description of the security group", - "name": "description", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" - } - ] - }, - { - "description": "Enables a role", - "isasync": false, - "name": "enableRole", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the 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 domain name of the owner", + "name": "domain", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" } - ], - "since": "4.20.0" + ] }, { - "description": "Configures a host's out-of-band management interface", + "description": "List VM Schedules.", "isasync": false, - "name": "configureOutOfBandManagement", + "name": "listVMSchedule", "params": [ { - "description": "the host management interface driver, for example: ipmitool", + "description": "", "length": 255, - "name": "driver", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the host", + "description": "ID of VM schedule", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, "type": "uuid" }, { - "description": "the host management interface user", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "username", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface IP address", + "description": "List by keyword", "length": 255, - "name": "address", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the host management interface password", + "description": "Action taken by schedule", "length": 255, - "name": "password", - "required": true, + "name": "action", + "required": false, "type": "string" }, { - "description": "the host management interface port", + "description": "", "length": 255, - "name": "port", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of VM schedule", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "Action", + "name": "action", + "type": "action" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", + "description": "VM schedule is enabled", "name": "enabled", "type": "boolean" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, - {}, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - } + {}, + {} ], - "since": "4.9.0" + "since": "4.19.0" }, { - "description": "List OAuth providers registered", - "isasync": false, - "name": "listOauthProvider", + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "isasync": true, + "name": "patchSystemVm", "params": [ { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the OAuth provider", + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "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": "page", + "name": "forced", "required": false, - "type": "integer" + "type": "boolean" } ], - "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ { - "description": "Name of the provider", - "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": "Name of the provider", - "name": "provider", - "type": "string" - }, {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - }, - { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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" + } + ], + "since": "4.17.0" + }, + { + "description": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ { - "description": "Description of the provider registered", - "name": "description", + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "list 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 cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": 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": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Lists storage tags", - "isasync": false, - "name": "listStorageTags", - "params": [ { "description": "", "length": 255, @@ -11941,6 +12009,21 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -11949,319 +12032,242 @@ "type": "string" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "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 only volumes that are encrypted", + "length": 255, + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" + }, + { + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.19.1", + "type": "uuid" } ], "related": "", "response": [ - {}, - {}, { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the name of the storage tag", - "name": "name", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the ID of the storage tag", - "name": "id", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "Delete Service Package", - "isasync": false, - "name": "deleteServicePackageOffering", - "params": [ + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { - "description": "the service offering ID", - "length": 255, - "name": "id", - "related": "registerNetscalerServicePackage,listRegisteredServicePackages", - "required": true, + "description": "the path of the volume", + "name": "path", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", "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": "Update a Shared FileSystem", - "isasync": false, - "name": "updateSharedFileSystem", - "params": [ + }, { - "description": "the ID of the shared filesystem", - "length": 255, + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "ID of the disk volume", "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the description for the shared filesystem.", - "length": 255, - "name": "description", - "required": false, + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the shared filesystem.", - "length": 255, - "name": "name", - "required": false, + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "response": [ + }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - {}, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - } - ], - "type": "list" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { @@ -12270,136 +12276,162 @@ "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + {}, + { + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the project name of the shared filesystem", + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + {}, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -12408,1533 +12440,1558 @@ "type": "boolean" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the shared filesystem", + "description": "the domain associated with the disk volume", "name": "domain", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + } + ], + "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 resource type such as UserVm, Template etc.", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "the UUID of the resource (optional)", + "length": 255, + "name": "resourceid", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.20.0" + "since": "4.13" }, { - "description": "Creates a IPv4 subnet for guest networks.", - "isasync": true, - "name": "createIpv4SubnetForGuestNetwork", + "description": "Lists SSL certificates", + "isasync": false, + "name": "listSslCerts", "params": [ { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "description": "Account ID", "length": 255, - "name": "cidrsize", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The CIDR of this Ipv4 subnet.", + "description": "ID of SSL certificate", "length": 255, - "name": "subnet", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Load balancer rule ID", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": false, "type": "uuid" } ], - "related": "listIpv4SubnetsForGuestNetwork", + "related": "uploadSslCert", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the network owner", + "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": "zonename", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" - }, - { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "name", + "name": "name", "type": "string" }, - {}, { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, - {} - ], - "since": "4.20.0" + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] }, { - "description": "Delete VM Schedule.", + "description": "List private gateways", "isasync": false, - "name": "deleteVMSchedule", + "name": "listPrivateGateways", "params": [ { - "description": "ID of VM schedule", + "description": "list gateways by vlan", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "vlan", + "required": false, + "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": "ID of VM", + "description": "list private gateway by 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": true, + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "required": false, "type": "uuid" }, { - "description": "IDs of VM schedule", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ids", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "listall", "required": false, - "type": "list" - } - ], - "response": [ - {}, - {}, + "type": "boolean" + }, { - "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "list gateways by ip address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" }, { - "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 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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { - "description": "the template ID", + "description": "list gateways by vpc", "length": 255, - "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", - "required": true, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" - } - ], - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", - "response": [ - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "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 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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - } - ] - }, - { - "description": "Updates an existing IPv4 subnet for a zone.", - "isasync": true, - "name": "updateIpv4SubnetForZone", - "params": [ - { - "description": "Id of the guest network IPv4 subnet", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "The new CIDR of the IPv4 subnet.", + "description": "list gateways by state", "length": 255, - "name": "subnet", - "required": true, + "name": "state", + "required": false, "type": "string" } ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" - }, - { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the account of the IPv4 subnet", + "description": "the account associated with the private gateway", "name": "account", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" - }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the IPv4 subnet", + "description": "the domain associated with the private gateway", "name": "domain", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "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": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, + {}, + {}, { - "description": "name of zone to which the IPv4 subnet belongs to.", + "description": "the name of the zone the private gateway belongs to", "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "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": "path of the domain to which the private gateway belongs", + "name": "domainpath", "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": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the entity type", - "length": 255, - "name": "entitytype", - "required": false, + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the id of the entity for which to show annotations", - "length": 255, - "name": "entityid", - "required": false, + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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" - } - ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", - "response": [ - { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "Destroys a system virtual machine.", + "description": "Update the default Ip of a VM Nic", "isasync": true, - "name": "destroySystemVm", + "name": "updateVmNicIp", "params": [ { - "description": "The ID of the system virtual machine", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "the 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 project name of the vm", + "name": "project", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the ID of the system VM", - "name": "id", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the name of the service offering of the system virtual machine.", + "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" - } - ] - }, - { - "description": "Adds Swift.", - "isasync": false, - "name": "addSwift", - "params": [ - { - "description": "the URL for swift", - "length": 255, - "name": "url", - "required": true, - "type": "string" }, { - "description": " key for the user for swift", - "length": 255, - "name": "key", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the username for swift", - "length": 255, - "name": "username", - "required": false, + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the account for swift", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "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", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - {}, - {} - ], - "since": "3.0.0" - }, - { - "description": "Archive one or more events.", - "isasync": false, - "name": "archiveEvents", - "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\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "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": "startdate", - "required": false, - "type": "date" - }, - { - "description": "archive by event type", - "length": 255, - "name": "type", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "listEvents", - "required": false, - "type": "list" - } - ], - "response": [ - { - "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "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 Autonomous Systems Numbers", - "isasync": false, - "name": "listASNumbers", - "params": [ - { - "description": "the vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the AS Number range ID", - "length": 255, - "name": "asnrangeid", - "related": "createASNRange,listASNRanges", - "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "domain id", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "AS number", - "length": 255, - "name": "asnumber", - "related": "listASNumbers", - "required": false, - "type": "integer" - }, - { - "description": "to indicate if the AS number is allocated to any network", - "length": 255, - "name": "isallocated", - "required": false, - "type": "boolean" - }, - { - "description": "account name", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the account name", - "name": "account", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain name", - "name": "domain", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Network ID", - "name": "associatednetworkid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "VPC ID", - "name": "vpcid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Domain ID", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "Allocation state", - "name": "allocationstate", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Account ID", - "name": "accountid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Network Name", - "name": "associatednetworkname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "VPC Name", - "name": "vpcname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "AS Number", - "name": "asnumber", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, - {}, { - "description": "Zone ID", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Allocated Date", - "name": "allocated", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "AS Number ID", - "name": "asnrangeid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the AS Number", - "name": "id", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the zone name of the AS Number range", - "name": "zonename", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "Created Date", - "name": "created", - "type": "date" - } - ], - "since": "4.20.0" - }, - { - "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 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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "List registered userdatas", - "isasync": false, - "name": "listUserData", - "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "id", - "related": "listUserData", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list 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 false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "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": "Userdata name to look for", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Name of the userdata", - "name": "name", - "type": "string" - }, - { - "description": "path of the domain to which the userdata owner belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id of the userdata", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain id of the userdata owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the owner id of the userdata", - "name": "accountid", - "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", - "type": "string" - }, - { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the owner of the userdata", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the userdata owner", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "base64 encoded userdata content", - "name": "userdata", - "type": "string" - }, - { - "description": "the project name of the userdata", - "name": "project", - "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", - "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 load balancer", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "related": "createLoadBalancer,listLoadBalancers", - "response": [ - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" - } - ], - "type": "list" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ + }, { - "description": "source port of the load balancer rule", - "name": "sourceport", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "instance port of the load balancer rule", - "name": "instanceport", + "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 state of the load balancer rule", - "name": "state", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "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 state of the instance", - "name": "state", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the name of the instance", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the instance ID", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of 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 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 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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -13943,691 +14000,911 @@ "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {}, - {}, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" } - ], - "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.", + "description": "Starts an existing internal lb vm.", "isasync": true, - "name": "scaleSystemVm", + "name": "startInternalLoadBalancerVM", "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": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "The ID of the system vm", + "description": "the ID of the internal lb vm", "length": 255, "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, - {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the control state of the host for the system VM", + "description": "the control state of the host for the router", "name": "hostcontrolstate", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "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": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the state of redundant virtual router", + "name": "redundantstate", "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 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 Pod name for the router", + "name": "podname", + "type": "string" }, - {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" - } - ] - }, - { - "description": "Lists snapshot policies.", - "isasync": false, - "name": "listSnapshotPolicies", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "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 name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "type": "uuid" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the ID of the snapshot policy", - "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", - "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, - "type": "integer" - } - ], - "related": "createSnapshotPolicy,updateSnapshotPolicy", - "response": [ + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the state of the router", + "name": "state", + "type": "state" }, + {}, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + } + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "updateDiskOffering", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "length": 255, + "name": "tags", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ] - }, - { - "description": "Update site to site vpn customer gateway", - "isasync": true, - "name": "updateVpnCustomerGateway", - "params": [ - { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "byteswriteratemax", + "required": false, + "since": "4.15", + "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", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "ikeversion", + "name": "cachemode", "required": false, - "since": "4.15.1", + "since": "4.15", "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "state of the disk offering", "length": 255, - "name": "dpd", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "ID of the disk offering", "length": 255, - "name": "ikepolicy", + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "id of customer gateway", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "iopsreadratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "public ip address id of the customer gateway", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "esplifetime", + "name": "bytesreadratemax", "required": false, + "since": "4.15", "type": "long" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "length (in seconds) of the burst", "length": 255, - "name": "ikelifetime", + "name": "iopswriteratemaxlength", "required": false, + "since": "4.15", "type": "long" }, { - "description": "name of this customer gateway", + "description": "an optional field, whether to display the offering to the end user or not.", + "length": 255, + "name": "displayoffering", + "required": false, + "type": "boolean" + }, + { + "description": "updates name of the disk offering with this value", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "ESP policy of the customer gateway", + "description": "length (in seconds) of the burst", "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" + "name": "iopsreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "sortkey", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" + "name": "byteswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "splitconnections", + "name": "bytesreadrate", "required": false, - "since": "4.15.1", - "type": "boolean" + "since": "4.15", + "type": "long" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "account", + "name": "iopsreadrate", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "forceencap", + "name": "iopswriteratemax", "required": false, - "type": "boolean" + "since": "4.15", + "type": "long" } ], - "related": "createVpnCustomerGateway,listVpnCustomerGateways", + "related": "createDiskOffering,listDiskOfferings", "response": [ - {}, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "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": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "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 project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the date this disk offering was created", + "name": "created", + "type": "date" + }, + { + "description": "length (in seconds) of the burst", + "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": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { - "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", + "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + }, + { + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "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 vpn gateway ID", - "name": "id", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + {}, + { + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the domain name of the owner", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the storage type for this disk offering", + "name": "storagetype", + "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 max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "the tags for the disk offering", + "name": "tags", "type": "string" } ] }, { - "description": "Verify the OAuth Code and fetch the corresponding user from provider", + "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", "isasync": false, - "name": "verifyOAuthCodeAndGetUser", + "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { "description": "", @@ -14637,18 +14914,11 @@ "type": "integer" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "", "length": 255, - "name": "secretcode", + "name": "pagesize", "required": false, - "type": "string" - }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -14656,49 +14926,76 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the IDs of the VMs to remove from the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "list" } ], - "related": "updateOauthProvider", + "related": "", "response": [ { - "description": "Name of the provider", - "name": "provider", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "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": "Name of the provider", - "name": "name", + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { - "description": "Description of the provider registered", - "name": "description", - "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", @@ -14710,95 +15007,192 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} - ], - "since": "4.19.0" + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] }, { - "description": "Updates object storage pool", - "isasync": false, - "name": "updateObjectStoragePool", + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", "params": [ { - "description": "Object Store ID", + "description": "id of vpn connection", "length": 255, "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", "required": true, "type": "uuid" }, { - "description": "the url for the object store", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "url", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name for the object store", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" } ], - "related": "addObjectStoragePool,listObjectStoragePools", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "the total size of the object store", - "name": "storagetotal", + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "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 name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, - {}, { - "description": "the url of the object store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the object store", + "description": "the project name", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the connection ID", "name": "id", "type": "string" }, { - "description": "the name of the object store", - "name": "name", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the object store currently used size", - "name": "storageused", + "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": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "List DRS plans for a clusters", + "description": "Lists Kubernetes clusters", "isasync": false, - "name": "listClusterDrsPlan", + "name": "listKubernetesClusters", "params": [ { "description": "", @@ -14808,20 +15202,25 @@ "type": "integer" }, { - "description": "ID of the drs plan", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "ID of the cluster", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "state", "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "List by keyword", @@ -14831,680 +15230,528 @@ "type": "string" }, { - "description": "", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "page", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "type": "integer" - } - ], - "related": "generateClusterDrsPlan,executeClusterDrsPlan", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "uuid" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", "type": "string" }, - {}, - {}, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, - {}, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "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": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, - { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "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": "Locks the specified account.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "Locks the specified account on this domain.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" } ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, + {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the ID of the role", - "name": "roleid", - "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 account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "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 user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "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", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "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": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, "type": "integer" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "the name of the account", + "description": "the name of the autoscale vmgroup", + "length": 255, "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "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.", + "length": 255, + "name": "minmembers", + "required": true, + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "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": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "length": 255, + "name": "maxmembers", + "required": true, + "type": "integer" + } + ], + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "response": [ { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "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 id of the account", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "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": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "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 type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "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 networks the account can own", - "name": "networklimit", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, + {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - } - ] - }, - { - "description": "Stops a router.", - "isasync": true, - "name": "stopRouter", - "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" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "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,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the project name of the address", + "description": "the project name of the vm group", "name": "project", "type": "string" }, { - "description": "the id of the router", + "description": "the autoscale vm group ID", "name": "id", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "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": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + } + ] + }, + { + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", + "params": [ { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "required": false, + "type": "list" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - {}, + "description": "UUID of the VPC which the Bgp Peers are associated to.", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { @@ -15513,333 +15760,239 @@ "type": "integer" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, + {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the 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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], - "type": "set" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "add a baremetal ping pxe server", + "isasync": true, + "name": "addBaremetalPxePingServer", + "params": [ { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "Username of PING storage server", + "length": 255, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "type of pxe device", + "length": 255, + "name": "pxeservertype", + "required": true, "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "Password of PING storage server", + "length": 255, + "name": "pingcifspassword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the Pod name for the router", - "name": "podname", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, + {}, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "the account associated with the router", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" + } + ] + }, + { + "description": "Deletes a load balancer rule.", + "isasync": true, + "name": "deleteLoadBalancerRule", + "params": [ { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID 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 clusters.", + "description": "list portable IP ranges", "isasync": false, - "name": "listClusters", + "name": "listPortableIpRanges", "params": [ { "description": "List by keyword", @@ -15849,220 +16002,173 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists clusters by Zone ID", + "description": "Id of the portable ip range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, "type": "uuid" }, { - "description": "lists clusters by Pod ID", + "description": "Id of a Region", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "regionid", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "", "length": 255, - "name": "managedstate", + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "createPortableIpRange", + "response": [ + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "lists clusters by the cluster name", - "length": 255, - "name": "name", - "required": false, + "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 ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "lists clusters by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { - "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": "lists clusters by cluster type", - "length": 255, - "name": "clustertype", - "required": false, + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "flag to display the capacity of the clusters", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "lists clusters by hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - } - ], - "related": "addCluster,updateCluster", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "the 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 Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the end ip of the portable IP range", + "name": "endip", "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 Zone name", - "name": "zonename", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the Pod name", - "name": "podname", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "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": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" } ], "type": "list" }, + {}, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" - }, + } + ] + }, + { + "description": "Returns user data associated with the VM", + "isasync": false, + "name": "getVirtualMachineUserData", + "params": [ { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - {}, + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the ID of the virtual machine", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -16070,580 +16176,652 @@ "name": "jobstatus", "type": "integer" }, + {} + ], + "since": "4.4" + }, + { + "description": "Updates network permissions.", + "isasync": false, + "name": "createNetworkPermissions", + "params": [ { - "description": "the cluster ID", - "name": "id", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "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 Zone name of the cluster", - "name": "zonename", + "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": "the 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 cluster name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } - ] + }, + {} + ], + "since": "4.17.0" }, { - "description": "Deletes project invitation", + "description": "Disables static rule for given IP address", "isasync": true, - "name": "deleteProjectInvitation", + "name": "disableStaticNat", "params": [ { - "description": "id of the invitation", + "description": "the public IP address ID for which static NAT feature is being disabled", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "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 current status of the latest async job 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": "Lists project invitations and provides detailed information for listed invitations", - "isasync": false, - "name": "listProjectInvitations", + "description": "Assigns secondary IP to NIC", + "isasync": true, + "name": "addIpToNic", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Secondary IP Address", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "keyword", - "required": false, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "Secondary IP address", + "name": "ipaddress", + "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": "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 ID of the nic", + "name": "nicid", + "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 vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "", + "description": "the ID of the secondary private IP addr", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the ID of the network", + "name": "networkid", + "type": "string" + } + ] + }, + { + "description": "Update the tariff plan for a resource", + "isasync": false, + "name": "quotaTariffUpdate", + "params": [ + { + "description": "DEPRECATED. Integer value for the usage type of the resource", "length": 255, - "name": "pagesize", + "name": "usagetype", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "Quota tariff's name", + "length": 65535, + "name": "name", + "required": true, + "since": "4.18.0.0", + "type": "string" + }, + { + "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "enddate", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "date" }, { - "description": "list invitations by state", - "length": 255, - "name": "state", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", "required": false, + "since": "4.18.0.0", "type": "string" }, { - "description": "list invitations by id", + "description": "The quota tariff value of the resource as per the default unit.", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "value", "required": false, - "type": "uuid" + "type": "double" }, { - "description": "list by project id", + "description": "Quota tariff's description. Inform empty to remove the description.", + "length": 65535, + "name": "description", + "required": false, + "since": "4.18.0.0", + "type": "string" + }, + { + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "page", + "name": "position", "required": false, + "since": "4.20.0.0", "type": "integer" } ], - "related": "", + "related": "quotaTariffList,quotaTariffCreate", "response": [ - {}, {}, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" + }, + { + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "currency", + "name": "currency", "type": "string" }, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "usageName", + "name": "usageName", "type": "string" }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the email the invitation was sent to", - "name": "email", - "type": "string" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the invitation", + "description": "the ID of the tariff", "name": "id", "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description", + "name": "description", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "the invitation state", - "name": "state", + "description": "name", + "name": "name", "type": "string" - } + }, + {} ], - "since": "3.0.0" + "since": "4.7.0" }, { - "description": "Lists all egress firewall rules for network ID.", + "description": "Delete a Ucs manager", "isasync": false, - "name": "listEgressFirewallRules", + "name": "deleteUcsManager", "params": [ { - "description": "", + "description": "ucs manager id", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "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 resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "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 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" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {} + ] + }, + { + "description": "Deletes a host.", + "isasync": false, + "name": "deleteHost", + "params": [ { - "description": "List resources by tags (key/value pairs)", + "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": "tags", + "name": "forced", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "the host ID", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "keyword", + "name": "forcedestroylocalstorage", "required": false, - "type": "string" - }, + "type": "boolean" + } + ], + "response": [ + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "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 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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", + "params": [ + { + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "type of the resource", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "resourcetype", + "required": true, + "type": "string" } ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "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 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" }, + {}, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Lists capabilities", + "isasync": false, + "name": "listCapabilities", + "params": [], + "related": "", + "response": [ + { + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" + }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", + "type": "boolean" }, - {}, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", + "type": "boolean" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", + "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "version of the cloud stack", + "name": "cloudstackversion", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" + }, + { + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", "type": "integer" - } - ] - }, - { - "description": "Updates a region", - "isasync": false, - "name": "updateRegion", - "params": [ + }, { - "description": "Id of region to update", - "length": 255, - "name": "id", - "required": true, - "type": "integer" + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", + "type": "boolean" }, { - "description": "updates region with this name", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, { - "description": "updates region with this end point", - "length": 255, - "name": "endpoint", - "required": false, + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" - } - ], - "related": "addRegion,listRegions", - "response": [ + }, { - "description": "the name of the region", - "name": "name", + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "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", - "type": "string" + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "type": "boolean" }, { - "description": "the ID of the region", - "name": "id", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", "type": "integer" }, + { + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", + "type": "long" + }, + { + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" + }, + { + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", + "type": "boolean" + }, {} ] }, { - "description": "Deletes traffic type of a physical network", + "description": "Release dedication of zone", "isasync": true, - "name": "deleteTrafficType", + "name": "releaseDedicatedZone", "params": [ { - "description": "traffic type id", + "description": "the ID of the Zone", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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", @@ -16653,526 +16831,583 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Destroy a Shared FileSystem by id", + "description": "Updates a network serviceProvider of a physical network", "isasync": true, - "name": "destroySharedFileSystem", + "name": "updateNetworkServiceProvider", "params": [ { - "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "expunge", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "forced", + "name": "servicelist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the ID of the shared filesystem to delete", + "description": "network service provider id", "length": 255, "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": false, + "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", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists clusters metrics", - "isasync": false, - "name": "listClustersMetrics", - "params": [ - { - "description": "lists clusters by the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" }, { - "description": "lists clusters by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "state of the network provider", + "name": "state", + "type": "string" }, + {}, { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "lists clusters by the cluster name", - "length": 255, - "name": "name", - "required": false, + "description": "uuid of the network provider", + "name": "id", "type": "string" - }, + } + ], + "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": "List by keyword", + "description": "parameter to repair the volume, leaks or all are the possible values", "length": 255, - "name": "keyword", + "name": "repair", "required": false, "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "The ID of the volume", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, + "name": "id", + "related": "importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, "type": "uuid" - }, + } + ], + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "flag to display the capacity of the clusters", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "lists clusters by hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "lists clusters by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, + {}, { - "description": "lists clusters by cluster type", - "length": 255, - "name": "clustertype", - "required": false, + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - {}, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, - {}, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "size of the disk volume", + "name": "size", + "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": "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": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the cluster ID", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "the project id of the vpn", + "name": "projectid", + "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": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "set" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "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": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists a project's project role permissions", - "isasync": false, - "name": "listProjectRolePermissions", - "params": [ - { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "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": "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", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the project", - "name": "projectid", + "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 read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" } ], - "since": "4.15.0" + "since": "4.19.1" }, { - "description": "Lists objects at specified path on a storage pool.", + "description": "Lists Management Server metrics", "isasync": false, - "name": "listStoragePoolObjects", + "name": "listManagementServersMetrics", "params": [ { - "description": "", + "description": "include system level stats", "length": 255, - "name": "page", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "id of the storage pool", + "description": "the name of the management server", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "path to list on storage pool", + "description": "the id of the management server", "length": 255, - "name": "path", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -17182,174 +17417,289 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "listImageStoreObjects", + "related": "", "response": [ + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" + }, + { + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, + { + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", "type": "long" }, { - "description": "Name of the data store object.", - "name": "name", + "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": "Template Name associated with the data store object.", - "name": "templatename", + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" + }, + { + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, - {}, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", + "description": "the system has a usage server running locally", + "name": "usageislocal", "type": "boolean" }, + {}, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, {}, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "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": "Format of template associated with the data store object.", - "name": "format", + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" + }, + { + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" + }, + { + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" + }, + { + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" + }, + { + "description": "the current cpu load", + "name": "cpuload", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all LDAP configurations", - "isasync": false, - "name": "listLdapConfigurations", - "params": [ + }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "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 java distribution name running the management server process", + "name": "javadistribution", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "The number of runnable threads", + "name": "threadsrunnablecount", "type": "integer" }, { - "description": "linked domain", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + } + ], + "since": "4.17.0" + }, + { + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "vmidipmap", "required": false, + "since": "4.4", + "type": "map" + }, + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": true, "type": "uuid" }, { - "description": "Port", + "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": "port", + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "integer" + "type": "list" } ], - "related": "addLdapConfiguration,deleteLdapConfiguration", "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": "port the ldap server is running on", - "name": "port", - "type": "int" + "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": "name of the host running the ldap server", - "name": "hostname", - "type": "string" - }, - { - "description": "linked domain", - "name": "domainid", - "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Lists secondary staging stores.", + "description": "Lists vm groups", "isasync": false, - "name": "listSecondaryStagingStores", + "name": "listInstanceGroups", "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -17365,30 +17715,30 @@ "type": "integer" }, { - "description": "the ID of the staging store", + "description": "list instance groups by ID", "length": 255, "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "the Zone ID for the staging store", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the staging store protocol", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "protocol", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the staging store", + "description": "list instance groups by name", "length": 255, "name": "name", "required": false, @@ -17400,47 +17750,23 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "the staging store provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "related": "createInstanceGroup,updateInstanceGroup", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - {}, { - "description": "the url of the image store", - "name": "url", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { @@ -17449,120 +17775,100 @@ "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" - } - ], - "since": "4.2.0" + }, + {} + ] }, { - "description": "Creates a l2tp/ipsec remote access vpn", + "description": "Creates a static route", "isasync": true, - "name": "createRemoteAccessVpn", + "name": "createStaticRoute", "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 domainId for the VPN. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "public ip address id of the vpn server", + "description": "the gateway id we are creating static route for", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": true, "type": "uuid" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "an optional account for the VPN. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "description": "static route cidr", "length": 255, - "name": "iprange", - "required": false, + "name": "cidr", + "required": true, "type": "string" } ], - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "related": "listStaticRoutes", "response": [ + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, - {}, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the id of the remote access vpn", + "description": "the ID of static route", "name": "id", "type": "string" }, - {}, { - "description": "the domain name of the account of the remote access vpn", + "description": "the domain associated with the static route", "name": "domain", "type": "string" }, @@ -17572,81 +17878,123 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "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 static route", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, + {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the state of the static route", + "name": "state", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" } ] }, { - "description": "Starts a router.", + "description": "Deletes a Private gateway", "isasync": true, - "name": "startRouter", + "name": "deletePrivateGateway", "params": [ { - "description": "the ID of the router", + "description": "the ID of the private gateway", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": true, "type": "uuid" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -17654,933 +18002,583 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Updates a domain with a new name", + "isasync": false, + "name": "updateDomain", + "params": [ { - "description": "the host ID for the router", - "name": "hostid", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "updates domain with this name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "ID of domain to update", + "length": 255, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "response": [ + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "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 control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, + {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the ID of the nic", - "name": "id", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the 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 (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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "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 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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the name of the router", - "name": "name", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the state of the domain", + "name": "state", + "type": "string" }, - {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "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", + "description": "Disables an AutoScale Vm Group", + "isasync": true, + "name": "disableAutoScaleVmGroup", "params": [ { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "The ID of the virtual machine", + "description": "the ID of the autoscale group", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "the service offering ID to apply to the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "required": true, "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "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": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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 password (if exists) of the virtual machine", - "name": "password", + "description": "the private port", + "name": "privateport", "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the 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 vm group was created", + "name": "created", + "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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 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 ISO attached to the virtual machine", - "name": "isoid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, + {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vm", + "description": "the project name of the vm group", "name": "project", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the state of the virtual machine", + "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the account owning the vm group", + "name": "account", "type": "string" - }, - {}, + } + ] + }, + { + "description": "Creates a snapshot policy for the account.", + "isasync": false, + "name": "createSnapshotPolicy", + "params": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "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": "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": "the name of the virtual machine", - "name": "name", - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "maximum number of snapshots to retain", + "length": 255, + "name": "maxsnaps", + "required": true, "type": "integer" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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 list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "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 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - } - ], - "type": "set" - }, + } + ], + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "response": [ { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the 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": "publicipid", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -18589,13 +18587,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -18604,158 +18597,199 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" } ], "type": "set" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "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": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + {} + ] + }, + { + "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", + "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the 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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, + "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 pool type of the virtual machine", - "name": "pooltype", + "description": "The ID of the volume to unmanage", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.1" + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" }, + {}, + {}, { - "description": "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": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { @@ -18764,571 +18798,243 @@ "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the role permission", + "name": "id", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, + "description": "the description of the role permission", + "name": "description", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "List system virtual machines.", + "isasync": false, + "name": "listSystemVms", + "params": [ { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the host ID of the system VM", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the state of the system VM", + "length": 255, + "name": "state", + "required": false, "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 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": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the system VM", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the Pod ID of the system VM", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the Zone ID of the system VM", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "User VM type", - "name": "vmtype", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the system VM", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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 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 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the state of the system VM", + "name": "state", "type": "string" }, - {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the first DNS for the system VM", + "name": "dns1", + "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 system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the template name for the system VM", + "name": "templatename", "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 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 date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the Account to reset the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the host ID for the system VM", + "name": "hostid", "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" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "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", - "required": false, - "type": "uuid" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "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,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - } - ], - "related": "listConfigurations,updateConfiguration", - "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", + "type": "string" + }, { - "description": "the category of the configuration", - "name": "category", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, + {}, { - "description": "the group of the configuration", - "name": "group", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { @@ -19337,607 +19043,457 @@ "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, - {}, { - "description": "the component of the configuration", - "name": "component", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the value of the configuration", - "name": "value", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the ID of the system VM", + "name": "id", "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 name of the parent configuration", - "name": "parent", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, - {} - ], - "since": "4.16.0" + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + } + ] }, { - "description": "Lists all available OS mappings for given hypervisor", - "isasync": false, - "name": "listGuestOsMapping", + "description": "Detaches a disk volume from a virtual machine.", + "isasync": true, + "name": "detachVolume", "params": [ { - "description": "list mapping by Guest OS Type UUID", + "description": "the ID of the disk volume", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, "type": "uuid" }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "page", + "name": "deviceid", "required": false, - "type": "integer" + "type": "long" }, { - "description": "List by keyword", + "description": "the ID of the virtual machine where the volume is detached from", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "string" - }, + "type": "uuid" + } + ], + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "list Guest OS mapping by OS display name", - "length": 255, - "name": "osdisplayname", - "required": false, - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "list mapping by its UUID", - "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", - "required": false, - "type": "uuid" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": false, + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - } - ], - "related": "addGuestOsMapping,updateGuestOsMapping", - "response": [ - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, - {}, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "List all public, private, and privileged templates.", - "isasync": false, - "name": "listTemplates", - "params": [ + }, { - "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 disk utilization", + "name": "utilization", "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": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "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": "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": "ID of the disk offering", + "name": "diskofferingid", + "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", - "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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 account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "If set to true, list only unique templates across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "pod name of the volume", + "name": "podname", "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" - } - ], - "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 date this template was created", - "name": "created", - "type": "date" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "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": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, - {}, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the status of the template", + "description": "the status of the volume", "name": "status", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the project name of the template", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", - "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -19946,8 +19502,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -19956,102 +19512,111 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the size of the template", - "name": "size", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" - }, + } + ] + }, + { + "description": "Replaces ACL associated with a network or private gateway", + "isasync": true, + "name": "replaceNetworkACLList", + "params": [ { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "the ID of the private gateway", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "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", @@ -20059,200 +19624,360 @@ "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 template display text", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - } + {} ] }, { - "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", + "description": "list Tungsten-Fabric address group", + "isasync": false, + "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" + "name": "addressgroupuuid", + "required": false, + "type": "string" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the ID of zone", "length": 255, - "name": "quiettime", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "", "length": 255, - "name": "duration", - "required": true, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "description": "", "length": 255, - "name": "action", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "related": "createTungstenFabricAddressGroup", "response": [ { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" + } + ] + }, + { + "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 list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the out-of-band management driver for the host", + "name": "driver", "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 the host", + "name": "hostid", + "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "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" } - ] + ], + "since": "4.9.0" }, { - "description": "Removes stratosphere ssp server", + "description": "Lists LDAP Users according to the specifications from the user request.", "isasync": false, - "name": "deleteStratosphereSsp", + "name": "listLdapUsers", "params": [ { - "description": "the host ID of ssp server", + "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": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, + "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" + }, + { + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "searchLdap,importLdapUsers", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The user's lastname", + "name": "lastname", + "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 authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, {}, + { + "description": "The user's email", + "name": "email", + "type": "string" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "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 firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "The user's username", + "name": "username", + "type": "string" + } + ], + "since": "4.2.0" }, { - "description": "deletes a range of Autonomous Systems for BGP Dynamic Routing", + "description": "Create VM Schedule", "isasync": false, - "name": "deleteASNRange", + "name": "createVMSchedule", "params": [ { - "description": "ID of the AS range", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "createASNRange,listASNRanges", + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "Description of the schedule", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": true, + "type": "string" + }, + { + "description": "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": "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": true, + "type": "string" + }, + { + "description": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "updateVMSchedule", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -20260,205 +19985,257 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists Usage Server metrics", - "isasync": false, - "name": "listUsageServerMetrics", - "params": [], - "related": "", - "response": [ + }, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", + "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": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", + "description": "Date when the schedule was created", + "name": "created", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { - "description": "the state of the usage server", - "name": "state", - "type": "state" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, - {} + { + "description": "Action", + "name": "action", + "type": "action" + } ], - "since": "4.17.0" + "since": "4.19.0" }, { - "description": "Creates a bucket in the specified object storage pool. ", - "isasync": true, - "name": "createBucket", + "description": "List the IP forwarding rules", + "isasync": false, + "name": "listIpForwardingRules", "params": [ { - "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.", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Id of the Object Storage Pool where bucket is created", + "description": "", "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool,listObjectStoragePools", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Enable bucket encryption", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "encryption", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "Enable object locking in bucket", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "objectlocking", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the bucket", + "description": "List by keyword", "length": 255, - "name": "name", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The Bucket access policy", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "policy", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "Enable bucket versioning", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "versioning", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "Bucket Quota in GB", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "quota", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "listBuckets", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "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 vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, {}, { - "description": "the list of resource tags associated", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -20467,108 +20244,27 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "set" - }, - { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the bucket", - "name": "domain", - "type": "string" - }, - { - "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": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" - }, - { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" - }, - { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" - }, - { - "description": "ID of the Bucket", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" - }, - { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" - }, - { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -20576,359 +20272,194 @@ "type": "integer" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "Bucket URL", - "name": "url", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" - } - ], - "since": "4.19.0" + }, + {} + ] }, { - "description": "Lists physical networks", - "isasync": false, - "name": "listPhysicalNetworks", + "description": "Creates an instant snapshot of a volume.", + "isasync": true, + "name": "createSnapshot", "params": [ { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "search by name", + "description": "the name of the snapshot", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "asynchronous backup if true", "length": 255, - "name": "pagesize", + "name": "asyncbackup", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, - "name": "keyword", + "name": "locationtype", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list physical network by id", + "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": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" - } - ], - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "response": [ - { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" - }, - { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "comma separated tag", + "description": "Map of tags (key/value pairs)", + "length": 255, "name": "tags", - "type": "string" - }, - { - "description": "zone id of the physical network", - "name": "zoneid", - "type": "string" - }, - { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" - }, - { - "description": "state of the physical network", - "name": "state", - "type": "string" - }, - { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" + "required": false, + "type": "map" }, { - "description": "name of the physical network", - "name": "name", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", - "params": [ - { - "description": "ID of the zone", + "description": "The ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" - } - ], - "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.11" - }, - { - "description": "Lists all firewall rules for an IP address.", - "isasync": false, - "name": "listFirewallRules", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "list" }, { - "description": "", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "pagesize", + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "quiesce vm if true", "length": 255, - "name": "isrecursive", + "name": "quiescevm", "required": false, "type": "boolean" - }, + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "response": [ { - "description": "list firewall rules for certain network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" + "description": "the account associated with the snapshot", + "name": "account", + "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 project id of the snapshot", + "name": "projectid", + "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": "id of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "ID of the snapshot", + "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", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "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 status of the template", + "name": "status", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createFirewallRule,updateEgressFirewallRule", - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the type of the snapshot", + "name": "snapshottype", "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", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -20936,19 +20467,14 @@ "name": "domainid", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -20957,259 +20483,355 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project name of the snapshot", + "name": "project", "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": "state of the disk volume", + "name": "volumestate", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, - {} - ] - }, - { - "description": " delete a Brocade VCS Switch", - "isasync": true, - "name": "deleteBrocadeVcsDevice", - "params": [ { - "description": "Brocade Switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "addBrocadeVcsDevice,listBrocadeVcsDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, - {} + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + } ] }, { - "description": "Lists all Routing firewall rules", + "description": "Lists storage pool metrics", "isasync": false, - "name": "listRoutingFirewallRules", + "name": "listStoragePoolsMetrics", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "listall", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the IP address for the storage pool", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "the storage pool path", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "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": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "isrecursive", + "name": "storagecustomstats", "required": false, + "since": "4.18.1", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list Routing firewall rules by network ID", + "description": "host ID of the storage pools", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "", + "description": "the status of the storage pool", "length": 255, - "name": "page", + "name": "status", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list Routing firewall rules by traffic type - ingress or egress", + "description": "the scope of the storage pool", "length": 255, - "name": "traffictype", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the storage pool", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", "required": false, "type": "string" } ], - "related": "createRoutingFirewallRule,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "disk size in GiB", + "name": "disksizetotalgb", + "type": "string" + }, + { + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "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", @@ -21217,287 +20839,423 @@ }, {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the Zone name of the storage pool", + "name": "zonename", "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the name of the storage pool", + "name": "name", "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "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 project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" } ], - "since": "4.20.0" + "since": "4.9.3" }, { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", + "description": "Create a new keypair and returns the private key", + "isasync": false, + "name": "createSSHKeyPair", "params": [ { - "description": "the ID of the ISO file", + "description": "Name of the keypair", "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": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "mode", - "required": true, + "name": "account", + "required": false, "type": "string" } ], - "related": "extractSnapshot,extractTemplate,extractVolume,downloadImageStoreObject", + "related": "", "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 name of the extracted object", - "name": "name", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "", - "name": "resultstring", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the status of the extraction", - "name": "status", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of extracted object", - "name": "id", - "type": "string" - } + {} ] }, { - "description": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", + "description": "list Tungsten-Fabric service group", + "isasync": false, + "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Routing firewall rule", + "description": "", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,updateRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "customid", + "name": "servicegroupuuid", "required": false, - "since": "4.4", "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": "createRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" + } + ] + }, + { + "description": "Authorizes a particular egress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupEgress", + "params": [ + { + "description": "end port for this egress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "start port for this egress rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "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 name of the security group. Mutually exclusive with securityGroupId parameter", + "length": 255, + "name": "securitygroupname", + "required": false, + "type": "string" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "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": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + } + ], + "related": "authorizeSecurityGroupIngress", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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 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" }, { @@ -21505,8 +21263,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -21515,28 +21273,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -21545,8 +21298,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -21555,179 +21308,168 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "type": "set" }, - {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Lists storage pools.", + "isasync": false, + "name": "listStoragePools", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If true, lists the custom stats of the storage pool", + "length": 255, + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the status of the storage pool", + "length": 255, + "name": "status", + "required": false, "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "list storage pools belongig to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", - "params": [ - { - "description": "the object store provider", + "description": "the name of the storage pool", "length": 255, - "name": "provider", + "name": "name", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the scope of the storage pool", "length": 255, - "name": "keyword", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the storage pool path", "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools", + "name": "path", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the object store", + "description": "the IP address for the storage pool", "length": 255, - "name": "name", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "page", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "addObjectStoragePool", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the ID of the object store", - "name": "id", - "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 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 provider name of the object store", - "name": "providername", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, - {}, { - "description": "the name of the object store", - "name": "name", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -21735,1221 +21477,761 @@ "type": "integer" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the url of the object store", - "name": "url", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "create secondary staging store.", - "isasync": false, - "name": "createSecondaryStagingStore", - "params": [ + }, { - "description": "the Zone ID for the staging store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the details for the staging store", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the scope of the staging store: zone only for now", - "length": 255, - "name": "scope", - "required": false, + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the staging store provider name", - "length": 255, + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "Storage provider for this pool", "name": "provider", - "required": false, "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ + }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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": "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": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the url of the image store", - "name": "url", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the name of the image store", - "name": "name", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" } ] }, { - "description": "Creates an affinity/anti-affinity group", - "isasync": true, - "name": "createAffinityGroup", + "description": "Updates a hypervisor capabilities.", + "isasync": false, + "name": "updateHypervisorCapabilities", "params": [ { - "description": "name of the affinity group", + "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "name", - "required": true, + "name": "maxhostspercluster", + "required": false, + "since": "4.16.0", + "type": "integer" + }, + { + "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "length": 255, + "name": "hypervisor", + "required": false, + "since": "4.19.1", "type": "string" }, { - "description": "create affinity group for project", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "maxguestslimit", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "domainId of the account owning the affinity group", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "vmsnapshotenabled", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", "required": false, "type": "uuid" }, { - "description": "optional description of the affinity group", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "description", + "name": "storagemotionenabled", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "an account for the affinity group. Must be used with domainId.", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "account", + "name": "securitygroupenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "type", - "required": true, + "name": "maxdatavolumeslimit", + "required": false, + "since": "4.16.0", + "type": "integer" + }, + { + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "length": 255, + "name": "hypervisorversion", + "required": false, + "since": "4.19.1", "type": "string" } ], - "related": "", + "related": "listHypervisorCapabilities", "response": [ { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, + {}, + {}, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - {}, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, - {}, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" } - ] + ], + "since": "3.0.0" }, { - "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": "Find hosts suitable for migrating a virtual machine.", "isasync": false, - "name": "oauthlogin", + "name": "findHostsForMigration", "params": [ { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "List by keyword", "length": 255, - "name": "domain", + "name": "keyword", "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.", + "description": "", "length": 255, - "name": "domainId", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Name of the provider", + "description": "", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Email id with which user tried to login using OAuth provider", + "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": "email", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, - "type": "string" - }, - { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, - "type": "string" + "type": "uuid" } ], - "related": "login", + "related": "", "response": [ { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "first name of the user", - "name": "firstname", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, - {}, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "User ID", - "name": "userid", - "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" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Lists all available Internal Load Balancer elements.", - "isasync": false, - "name": "listInternalLoadBalancerElements", - "params": [ { - "description": "list internal load balancer elements by network service provider id", - "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": false, - "type": "uuid" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "list internal load balancer elements by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "list internal load balancer elements by id", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", - "required": false, - "type": "uuid" - } - ], - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement", - "response": [ + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "string" + }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the id of the internal load balancer element", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", "name": "id", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates load balancer health check policy", - "isasync": true, - "name": "updateLBHealthCheckPolicy", - "params": [ + }, { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "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": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "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 date and time the host was created", + "name": "created", + "type": "date" + }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the name of the host", + "name": "name", "type": "string" }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" + }, + { + "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - } - ], - "type": "list" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, - {}, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "description": "the cpu average load on the host", + "name": "averageload", + "type": "long" }, { - "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": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Keyword for guest os name", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the hypervisor", + "description": "the host hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the guest OS list of the hypervisor", - "name": "guestoslist", - "response": [ - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" - } - ], - "type": "list" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", + "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" } - ], - "since": "4.19.0" + ] }, { - "description": "Reboots a virtual machine.", + "description": "Enable a Cisco Nexus VSM device", "isasync": true, - "name": "rebootVirtualMachine", + "name": "enableCiscoNexusVSM", "params": [ { - "description": "Force reboot the VM (VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "The ID of the virtual machine", + "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", "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,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", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - {}, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, + } + ] + }, + { + "description": "Return true if the specified account is allowed to create offerings with tags.", + "isasync": false, + "name": "isAccountAllowedToCreateOfferingsWithTags", + "params": [ { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + {}, {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, + "description": "is domain admin allowed to create offerings with tags", + "name": "isallowed", + "type": "boolean" + } + ] + }, + { + "description": "Adds VM to specified network by creating a NIC", + "isasync": true, + "name": "addNicToVirtualMachine", + "params": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptions", + "required": false, + "type": "map" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Mac Address for the new network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the VM's primary IP address", + "description": "IP Address for the new network", + "length": 255, "name": "ipaddress", + "required": false, "type": "string" - }, + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { @@ -22958,18 +22240,13 @@ "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 name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -22977,8 +22254,18 @@ "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -22987,9 +22274,9 @@ "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": "ID of the VLAN/VNI if available", @@ -22997,88 +22284,83 @@ "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -23087,23 +22369,13 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -23112,36 +22384,41 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the 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": "the type of the nic", - "name": "type", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -23150,8 +22427,84 @@ "type": "date" }, { - "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -23160,86 +22513,151 @@ "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 read (IO) of disk on the VM", - "name": "diskioread", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "the write (IO) of disk on the VM", @@ -23247,195 +22665,196 @@ "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "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 ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -23443,44 +22862,55 @@ "name": "receivedbytes", "type": "long" }, + {}, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -23488,311 +22918,543 @@ "name": "username", "type": "string" }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the id of userdata used for the VM", "name": "userdataid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "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": "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": "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {} + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + } ] }, { - "description": "Enables HA cluster-wide", - "isasync": true, - "name": "enableHAForCluster", + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", "params": [ { - "description": "ID of the cluster", + "description": "list static route by id", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, + "name": "id", + "related": "listStaticRoutes", + "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", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "Creates a load balancer rule", - "isasync": true, - "name": "createLoadBalancerRule", - "params": [ - { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "description": "list static routes by state", "length": 255, - "name": "protocol", + "name": "state", "required": false, "type": "string" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the public port from where the network traffic will be load balanced from", + "description": "", "length": 255, - "name": "publicport", - "required": true, + "name": "page", + "required": false, "type": "integer" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", + "description": "list static routes by gateway id", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "list static routes by vpc id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "privateport", - "required": true, - "type": "integer" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the domain ID associated with the load balancer", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "name of the load balancer rule", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "openfirewall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "cidrlist", + "name": "account", "required": false, - "since": "4.18.0.0", - "type": "list" + "type": "string" } ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", + "related": "", "response": [ { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the project id of the load balancer", + "description": "the project id of the static route", "name": "projectid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "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", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "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 state of the rule", + "description": "the state of the static route", "name": "state", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { @@ -23801,37 +23463,43 @@ "type": "integer" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -23840,264 +23508,152 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "Adds a guest OS name to hypervisor OS name mapping", - "isasync": true, - "name": "addGuestOsMapping", - "params": [ + }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the ID of static route", + "name": "id", "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": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, + "description": "the domain associated with the static route", + "name": "domain", "type": "string" - }, + } + ] + }, + { + "description": "Lists all public ip addresses", + "isasync": false, + "name": "listPublicIpAddresses", + "params": [ { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "description": "list only static NAT IP addresses", "length": 255, - "name": "forced", + "name": "isstaticnat", "required": false, - "since": "4.19.0", "type": "boolean" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "osmappingcheckenabled", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.19.0", "type": "boolean" - } - ], - "related": "updateGuestOsMapping", - "response": [ - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" - }, - {}, - { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" + "description": "list only IPs used for load balancing", + "length": 255, + "name": "forloadbalancing", + "required": false, + "type": "boolean" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "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" }, - {} - ], - "since": "4.4.0" - }, - { - "description": "Disables out-of-band management for a zone", - "isasync": true, - "name": "disableOutOfBandManagementForZone", - "params": [ { - "description": "the ID of the zone", + "description": "lists all public IP addresses by zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", - "response": [ - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" }, { - "description": "the operation result", - "name": "status", + "description": "list only source NAT IP addresses", + "length": 255, + "name": "issourcenat", + "required": false, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "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 driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - {}, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the operation result description", - "name": "description", - "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" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - } - ], - "since": "4.9.0" - }, - { - "description": "List all public, private, and privileged VNF templates.", - "isasync": false, - "name": "listVnfTemplates", - "params": [ - { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "list resources by account. Must be used with the domainId parameter.", "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", + "name": "account", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "the template name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "flag to display the resource image for the templates", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "showicon", + "name": "allocatedonly", "required": false, "type": "boolean" }, @@ -24109,161 +23665,209 @@ "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "lists all public IP addresses by state", "length": 255, - "name": "hypervisor", + "name": "state", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "listall", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "List by keyword", "length": 255, - "name": "isvnf", + "name": "keyword", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the virtual network for the IP address", "length": 255, - "name": "arch", + "name": "forvirtualnetwork", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "details", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.15", - "type": "list" + "type": "uuid" }, { - "description": "list datadisk templates by parent template id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "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", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "the template ID", + "description": "lists all public IP addresses by source network 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", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.13.0", "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "lists IP address by ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "If set to true, list only unique templates across zones", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "showunique", + "name": "forsystemvms", "required": false, - "since": "4.13.2", + "since": "4.20.0", "type": "boolean" + } + ], + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "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", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + }, { - "description": "the list of resource tags associated", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "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": "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 account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -24277,8 +23881,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -24286,19 +23890,29 @@ "name": "domainpath", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -24307,208 +23921,215 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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 template name", - "name": "name", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - {}, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "is public IP portable across the zones", + "name": "isportable", + "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": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "CPU Arch of the template", - "name": "arch", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" - }, + } + ] + }, + { + "description": "Lists OpenDyalight controllers", + "isasync": false, + "name": "listOpenDaylightControllers", + "params": [ { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the template ID", + "description": "the ID of a OpenDaylight Controller", + "length": 255, "name": "id", - "type": "string" - }, + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, + "type": "uuid" + } + ], + "related": "addOpenDaylightController,deleteOpenDaylightController", + "response": [ { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the url of the controller api", + "name": "url", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "device id of the controller", + "name": "id", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, + {}, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ { - "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 tag of this template", - "name": "templatetag", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ { - "description": "the project id of the template", - "name": "projectid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { @@ -24517,866 +24138,182 @@ "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "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": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "NAT support", + "name": "nat", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the controller password", + "name": "password", "type": "string" }, + {}, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "the controller username", + "name": "username", "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" } ], - "since": "4.19.0" + "since": "4.6.0" }, { - "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "description": "Changes the default NIC on a VM", "isasync": true, - "name": "deployVnfAppliance", + "name": "updateDefaultNicForVirtualMachine", "params": [ { - "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 ipv6 address for default vm's network", + "description": "NIC ID", "length": 255, - "name": "ip6address", - "required": false, - "type": "string" + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" }, { - "description": "Controls specific policies on IO", + "description": "Virtual Machine ID", "length": 255, - "name": "iodriverpolicy", - "required": false, - "type": "string" - }, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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 user's name who deployed the virtual machine", + "name": "username", + "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": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "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": "the number of vCPUs this virtual machine is using", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "device type of the root volume", + "name": "rootdevicetype", "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,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "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,updateSecurityGroup", - "required": false, + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "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,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", - "length": 255, - "name": "keyboard", - "required": false, - "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": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 mac address for default vm's network", - "length": 255, - "name": "macaddress", - "required": false, + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.2", - "type": "boolean" - }, - { - "description": "Deploy vm for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "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.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "since": "4.11", - "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, - "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, - "type": "string" - }, - { - "description": "The number of queues for multiqueue NICs.", - "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" - }, - { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", - "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" - }, - { - "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 ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", - "length": 255, - "name": "vnfconfiguremanagement", - "required": false, - "type": "boolean" - }, - { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "true if start vm after creating; defaulted to true if not specified", - "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" - }, - { - "description": "Enable packed virtqueues or not.", - "length": 255, - "name": "nicpackedvirtqueuesenabled", - "required": false, - "since": "4.18", - "type": "boolean" - }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "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": "used to specify the vApp properties.", - "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" - }, - { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "The 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": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", - "length": 255, - "name": "details", - "required": false, - "since": "4.3", - "type": "map" - }, - { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - {}, - { - "description": "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "Vm 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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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 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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -25384,99 +24321,37 @@ "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "security group name", + "name": "securitygroupname", "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": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -25494,8 +24369,8 @@ "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" }, { @@ -25504,8 +24379,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -25519,13 +24394,13 @@ "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" }, { @@ -25541,156 +24416,146 @@ ], "type": "set" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -25699,23 +24564,18 @@ "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the name of the security group", + "name": "name", "type": "string" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -25723,358 +24583,384 @@ "name": "id", "type": "string" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the description of the security group", "name": "description", "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "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" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 account owning the affinity group", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "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 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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", + "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": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the affinity group", + "name": "name", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the 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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, - {}, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "device ID of the root volume", @@ -26082,510 +24968,204 @@ "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates a network offering.", - "isasync": false, - "name": "updateNetworkOffering", - "params": [ - { - "description": "update state for the network offering", - "length": 255, - "name": "state", - "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, + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", - "length": 255, - "name": "keepaliveenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + {}, { - "description": "sort key of the network offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the id of the network offering", - "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 255, - "name": "domainid", - "required": false, - "type": "string" - }, - { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "related": "createNetworkOffering,listNetworkOfferings", - "response": [ - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the account associated with the virtual machine", + "name": "account", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "availability of the network offering", - "name": "availability", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "additional key/value details tied with network offering", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the name of the network offering", - "name": "name", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "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": "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" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the id of the network offering", + "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the 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 used by virtual router provider", - "name": "serviceofferingid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - } - ] - }, - { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, + "description": "the project id of the vm", "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "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": "fordisplay", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - } - ], - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "response": [ - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -26594,18 +25174,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -26614,276 +25194,300 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "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 starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, - {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] }, { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", + "description": "Generate DRS plan for a cluster", + "isasync": false, + "name": "generateClusterDrsPlan", "params": [ { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, - { - "description": "The ID of the system virtual machine", + "description": "the ID of the Cluster", "length": 255, "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", + "length": 255, + "name": "migrations", + "required": false, + "type": "integer" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "related": "executeClusterDrsPlan", "response": [ { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, + {}, { - "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" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", + "params": [ { - "description": "the second DNS for the system VM", - "name": "dns2", - "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 link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ + { + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" }, - {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the out-of-band management interface password", + "name": "password", "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 out-of-band management driver for the host", + "name": "driver", "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 out-of-band management interface username", + "name": "username", + "type": "string" }, {}, { - "description": "the ID of the system VM", - "name": "id", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, + {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "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 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", @@ -26891,305 +25495,304 @@ "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" - }, + } + ], + "since": "4.9.0" + }, + { + "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "isasync": true, + "name": "createSharedFileSystem", + "params": [ { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the description for the shared filesystem.", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Deletes an egress firewall rule", - "isasync": true, - "name": "deleteEgressFirewallRule", - "params": [ - { - "description": "the ID of the firewall rule", + "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": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "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": "the name of the shared filesystem.", + "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": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, - {} - ] - }, - { - "description": "Updates a VPC", - "isasync": true, - "name": "updateVPC", - "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "filesystem", + "required": true, "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "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": "sourcenatipaddress", + "name": "provider", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the id of the VPC", + "description": "the zone id.", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the display text of the VPC", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "displaytext", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the name of the VPC", + "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": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "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": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "network to attach the shared filesystem to", "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "name of the shared filesystem", + "name": "name", + "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, + {}, { - "description": "the 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": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "description of the shared filesystem", + "name": "description", + "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "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", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated with the project", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -27198,431 +25801,483 @@ "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" } ], - "type": "list" + "type": "set" }, { - "description": "the id of the VPC", - "name": "id", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the list of supported services", - "name": "service", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "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 physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 service name", - "name": "name", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "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" - } - ], + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "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 cidr of IPv6 network", + "name": "ip6cidr", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" } ], "type": "list" }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the cidr the VPC", - "name": "cidr", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project name of the VPC", + "description": "the project name of the shared filesystem", "name": "project", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, - {} - ] + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + } + ], + "since": "4.20.0" }, { - "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", + "description": "Deletes network device.", + "isasync": false, + "name": "deleteNetworkDevice", "params": [ { - "description": "the ID of the host", + "description": "Id of network device to delete", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", - "length": 255, - "name": "password", - "required": false, - "type": "string" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", "response": [ - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management 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 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 out-of-band management interface address", - "name": "address", - "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 port", - "name": "port", - "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 driver for the host", - "name": "driver", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - } - ], - "since": "4.9.0" + {} + ] }, { - "description": "List VM Schedules.", + "description": "Updates image store read-only status", "isasync": false, - "name": "listVMSchedule", + "name": "updateImageStore", "params": [ { - "description": "List by keyword", + "description": "Image Store UUID", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "The new name for the Image Store.", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of VM schedule", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "enabled", + "name": "readonly", "required": false, "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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,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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "Action taken by schedule", - "length": 255, - "name": "action", - "required": false, - "type": "string" - }, - { - "description": "ID of VM schedule", + "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": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "capacitybytes", "required": false, - "type": "uuid" + "type": "long" } ], - "related": "createVMSchedule,updateVMSchedule", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, - {}, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" - } + }, + {} ], - "since": "4.19.0" + "since": "4.15.0" }, { - "description": "List resource detail(s)", - "isasync": false, - "name": "listResourceDetails", + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", "params": [ { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" }, { - "description": "list by resource type", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "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": "fordisplay", + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": false, - "since": "4.3", + "type": "list" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "the UUID of the latest async job acting on 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": "Lists all pending asynchronous jobs for the account.", + "isasync": false, + "name": "listAsyncJobs", + "params": [ + { + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "value", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -27632,26 +26287,27 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by key", + "description": "The id of the management server", "length": 255, - "name": "key", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "List by keyword", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "keyword", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "", @@ -27660,13 +26316,6 @@ "required": false, "type": "integer" }, - { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "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, @@ -27675,497 +26324,272 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "listTags", + "related": "queryAsyncJobResult", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, + {}, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" - } - ], - "since": "4.2" - }, - { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", - "isasync": true, - "name": "patchSystemVm", - "params": [ - { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" }, { - "description": "patches systemVM - CPVM/SSVM with the specified ID", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "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": "the async command executed", + "name": "cmd", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the UUID of the latest async job acting 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": "Creates a network offering.", + "description": "Archive one or more alerts.", "isasync": false, - "name": "createNetworkOffering", + "name": "archiveAlerts", "params": [ { - "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 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": "guest type of the network offering: Shared or Isolated", - "length": 255, - "name": "guestiptype", - "required": true, - "type": "string" - }, - { - "description": "true if network offering for NSX network offering supports Load balancer service.", - "length": 255, - "name": "nsxsupportlb", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, - { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the IDs of the alerts", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, "type": "list" }, { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "desired service capabilities as part of network offering", + "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": "servicecapabilitylist", + "name": "startdate", "required": false, - "type": "map" + "type": "date" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "description": "archive by alert type", "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "name": "type", "required": false, "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", - "length": 255, - "name": "ispersistent", - "required": false, - "type": "boolean" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", - "required": false, - "type": "map" - }, - { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "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": "keepaliveenabled", + "name": "enddate", "required": false, - "type": "boolean" - }, + "type": "date" + } + ], + "response": [ { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, - "name": "conservemode", - "required": false, - "type": "boolean" - }, - { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "true if network offering supports choosing AS number", - "length": 255, - "name": "specifyasnumber", - "required": false, - "since": "4.20.0", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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 traffic type for the network offering. Supported type in current release is GUEST only", - "length": 255, - "name": "traffictype", - "required": true, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", + "params": [ { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "Cisco Vnmc resource ID", "length": 255, - "name": "egressdefaultpolicy", - "required": false, - "type": "boolean" - }, + "name": "resourceid", + "related": "addCiscoVnmcResource,listCiscoVnmcResources", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", - "length": 255, - "name": "routingmode", - "required": false, - "since": "4.20.0", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", - "length": 255, - "name": "fortungsten", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the display text of the network offering, defaults to the value of 'name'.", - "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": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, - "name": "forvpc", - "required": false, + "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": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "fornsx", - "required": false, - "since": "4.20.0", - "type": "boolean" + "name": "type", + "required": true, + "type": "string" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "The description of the heuristic rule.", "length": 255, - "name": "networkmode", - "required": false, - "since": "4.20.0", + "name": "description", + "required": true, "type": "string" }, { - "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": "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 ID of the containing zone(s), null for public offerings", + "description": "The zone in which the heuristic rule will be applied.", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" - }, - { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "required": true, + "type": "uuid" }, { - "description": "the name of the network offering", + "description": "The name identifying the heuristic rule.", "length": 255, "name": "name", "required": true, "type": "string" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, - "type": "integer" } ], - "related": "listNetworkOfferings", + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ { - "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 network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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": "the date this network offering was created", + "description": "When the heuristic was created.", "name": "created", "type": "date" }, + {}, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -28173,480 +26597,429 @@ "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" }, { - "description": "the id of the network offering", + "description": "ID of the heuristic.", "name": "id", "type": "string" }, + {}, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", + "params": [ { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", - "type": "boolean" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "Hostname of ip address of the Brocade VCS Switch.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" - }, + } + ], + "related": "listBrocadeVcsDevices", + "response": [ { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "device name", + "name": "brocadedevicename", "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": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" - }, + } + ] + }, + { + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", + "params": [ { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "Delete tags matching key/value pairs", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "Delete tag by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "Delete tags for resource id(s)", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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", + "type": "string" } ], - "since": "3.0.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 containing domain", + "description": "Tungsten-Fabric tag type name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "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 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 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 ID of the cluster", - "name": "clusterid", - "type": "string" - }, {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, - {}, { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "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 name", + "name": "name", + "type": "string" } ] }, { - "description": "Creates an IP forwarding rule", - "isasync": true, - "name": "createIpForwardingRule", + "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": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "Username", "length": 255, - "name": "protocol", + "name": "username", "required": true, "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "the end port for the rule", + "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": "endport", + "name": "domain", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the start port for the rule", + "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": "startport", + "name": "password", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "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": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "domainId", + "required": false, + "type": "long" } ], - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "oauthlogin", "response": [ { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "Is user registered", + "name": "registered", "type": "string" }, + {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "Username", + "name": "username", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the time period before the session has expired", + "name": "timeout", "type": "integer" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "list" + "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": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "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": "Lists volume metrics", - "isasync": false, - "name": "listVolumesMetrics", + "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": "List resources by tags (key/value pairs)", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "tags", + "name": "makeredundant", "required": false, - "type": "map" + "since": "4.11.1", + "type": "boolean" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "state", + "name": "livepatch", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "If cleanup old network elements", "length": 255, - "name": "listall", + "name": "cleanup", "required": false, "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "The ID of the network to restart.", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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 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": "any text associated with the success or failure", + "name": "displaytext", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "", "length": 255, - "name": "listsystemvms", + "name": "page", "required": false, - "since": "4.18", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the disk volume", + "description": "ID of the hypervisor capability", "length": 255, "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "listHypervisorCapabilities", "required": false, "type": "uuid" }, @@ -28658,512 +27031,291 @@ "type": "integer" }, { - "description": "list only volumes that are encrypted", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "isencrypted", + "name": "hypervisor", "required": false, - "since": "4.19.1", - "type": "boolean" + "type": "string" }, { - "description": "list volumes by disk offering", + "description": "List by keyword", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "keyword", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { - "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 hypervisor type", + "name": "hypervisor", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", + "description": "true if security group is supported", + "name": "securitygroupenabled", "type": "boolean" }, { - "description": "list volumes on specified host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", "type": "integer" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Delete Project roles in CloudStack", + "isasync": false, + "name": "deleteProjectRole", + "params": [ { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "ID of the project role to be deleted", "length": 255, - "name": "ids", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "since": "4.9", - "type": "list" + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "ID of the project from where the role is to be deleted", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "required": true, "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], - "related": "", "response": [ - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "List the preset variables available for using in the Quota tariff activation rules given the usage type.", + "isasync": false, + "name": "quotaPresetVariablesList", + "params": [ { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "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 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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, + "description": "The usage type for which the preset variables will be retrieved.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the state of the disk volume", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "variable", + "name": "variable", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "description", + "name": "description", "type": "string" }, + {} + ], + "since": "4.20" + }, + { + "description": "Create a quota balance statement", + "isasync": false, + "name": "quotaBalance", + "params": [ { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "Start of the period of the Quota balance. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "End of the period of the Quota balance.The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "enddate", + "required": false, "type": "date" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": true, "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, + } + ], + "related": "quotaStatement", + "response": [ { - "description": "pod name of the volume", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "usage type", + "name": "type", + "type": "int" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "account id", + "name": "accountid", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "usage type name", + "name": "name", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "domain id", + "name": "domain", "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "usage unit", + "name": "unit", "type": "string" }, {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.7.0" + }, + { + "description": "Get SolidFire Account ID", + "isasync": false, + "name": "getSolidFireAccountId", + "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": "CloudStack Account UUID", + "length": 255, + "name": "accountid", + "required": true, "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "description": "Storage Pool UUID", + "length": 255, "name": "storageid", + "required": true, "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "disk size in GiB", - "name": "sizegb", - "type": "string" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "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 write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, + } + ], + "related": "", + "response": [ { - "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 UUID of the latest async job acting on this object", @@ -29172,285 +27324,240 @@ }, {}, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "SolidFire Account ID", + "name": "solidFireAccountId", "type": "long" }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - } - ], - "since": "4.9.3" + {} + ] }, { - "description": "Lists the network Interfaces of elastistor", + "description": "Lists role permissions", "isasync": false, - "name": "listElastistorInterface", + "name": "listRolePermissions", "params": [ { - "description": "controller id", + "description": "ID of the role", "length": 255, - "name": "controllerid", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listElastistorVolume", + "related": "", "response": [ - {}, { - "description": "compression", - "name": "compression", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the id of the volume", - "name": "id", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "deduplication", - "name": "deduplication", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "synchronization", - "name": "sync", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" }, - {}, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "description": "Lists dedicated guest vlan ranges", "isasync": false, - "name": "listDetailOptions", + "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "the UUID of the resource (optional)", + "description": "zone of the guest VLAN range", "length": 255, - "name": "resourceid", + "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 resource type such as UserVm, Template etc.", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "resourcetype", - "required": true, + "name": "account", + "required": false, "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" + "description": "physical network id of the guest VLAN range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "project who will own the guest VLAN range", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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" - } - ], - "since": "4.13" - }, - { - "description": "Lists SSL certificates", - "isasync": false, - "name": "listSslCerts", - "params": [ + }, { - "description": "ID of SSL certificate", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Project that owns the SSL certificate", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "Load balancer rule ID", + "description": "the dedicated guest vlan range", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "uploadSslCert", + "related": "dedicateGuestVlanRange", "response": [ + {}, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "certificate", - "name": "certificate", - "type": "string" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, { - "description": "name", - "name": "name", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "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 zone of the guest vlan range", + "name": "zoneid", + "type": "long" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "certificate chain", - "name": "certchain", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" - }, - {}, - { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" } ] }, { - "description": "List private gateways", + "description": "Lists all network ACL items", "isasync": false, - "name": "listPrivateGateways", + "name": "listNetworkACLs", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list network ACL items by action", "length": 255, - "name": "account", + "name": "action", "required": false, "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, @@ -29459,27 +27566,34 @@ "type": "boolean" }, { - "description": "list gateways by state", + "description": "list network ACL items by protocol", "length": 255, - "name": "state", + "name": "protocol", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "listall", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list gateways by vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -29488,2654 +27602,2020 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list network ACL items by ACL ID", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list gateways by ip address", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddress", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list gateways by vlan", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vlan", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list private gateway by id", + "description": "Lists network ACL Item with the specified ID", "length": 255, "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list network ACL items by network ID", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" - }, - { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", + "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", - "type": "string" - }, - { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the domain associated with the private gateway", - "name": "domain", - "type": "string" - }, - { - "description": "the gateway", - "name": "gateway", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, - { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" - }, - { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" - }, - { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" - }, - { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, - {}, { - "description": "the id of the private gateway", + "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", - "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, - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", "response": [ { - "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 project ID of the affinity group", - "name": "projectid", + "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "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 domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" - }, - {}, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "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": "Copies a template from one zone to another.", + "isasync": true, + "name": "copyTemplate", + "params": [ + { + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "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" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "Template ID.", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "tag value", - "name": "value", - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "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 account name to which the template belongs", + "name": "account", + "type": "string" }, - {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 isolation uri of the nic", - "name": "isolationuri", - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address 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 name of the corresponding network", - "name": "networkname", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", + "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "description": "true if the reset password feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the project name of the vm", + "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "lists network that are using a nicira nvp device", + "isasync": false, + "name": "listNiciraNvpDeviceNetworks", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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": "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": "the group ID of the virtual machine", - "name": "groupid", + "description": "nicira nvp device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "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": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "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", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the network's netmask", + "name": "netmask", + "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 state of the virtual machine", - "name": "state", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of services", + "name": "service", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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": "tag value", - "name": "value", + "description": "the service name", + "name": "name", "type": "string" } ], - "type": "set" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "type": "list" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", - "params": [ - { - "description": "id of lb stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "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", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "response": [ - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "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": "the date this network was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Lists all Pods.", - "isasync": false, - "name": "listPods", - "params": [ - { - "description": "list Pods by ID", - "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "flag to display the capacity of the pods", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "list Pods by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list Pods by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "updatePod,createManagementNetworkIpRange", - "response": [ - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "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 owner of the network", + "name": "account", + "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the domain id of the network owner", + "name": "domainid", "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 routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, - {}, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - } - ], - "type": "list" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - {}, + }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the zone the network belongs to", + "name": "zonename", "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": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - } - ], - "type": "set" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "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 hostname for the router", - "name": "hostname", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "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": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" + } + ] + }, + { + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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 version of template", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "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 corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "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 account associated with the router", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "list ovs elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": false, + "type": "uuid" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "list ovs elements by id", + "length": 255, + "name": "id", + "related": "listOvsElements,configureOvsElement", + "required": false, + "type": "uuid" + } + ], + "related": "configureOvsElement", + "response": [ + { + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "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": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the router", - "name": "name", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the id of the ovs", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "associate a profile to a blade", + "isasync": true, + "name": "associateUcsProfileToBlade", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "blade id", + "length": 255, + "name": "bladeid", + "related": "associateUcsProfileToBlade", + "required": true, + "type": "uuid" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, + {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "ucs blade id", + "name": "id", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, + {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Updates a disk offering.", + "description": "Checks the 2FA code for the user.", "isasync": false, - "name": "updateDiskOffering", + "name": "validateUserTwoFactorAuthenticationCode", "params": [ { - "description": "burst io requests write rate of the disk offering", + "description": "two factor authentication code", "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" - }, + "name": "codefor2fa", + "required": true, + "type": "string" + } + ], + "response": [ { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field, whether to display the offering to the end user or not.", - "length": 255, - "name": "displayoffering", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Updates a VMware datacenter details for a zone", + "isasync": false, + "name": "updateVmwareDc", + "params": [ { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "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": "tags", + "name": "vcenter", "required": false, - "since": "4.15", "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "The password for specified username.", "length": 255, - "name": "zoneid", + "name": "password", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", "required": false, - "since": "4.13", "type": "string" }, { - "description": "length (in seconds) of the burst", + "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": "bytesreadratemaxlength", + "name": "isrecursive", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "bytes read rate of the disk offering", + "description": "The zone ID", "length": 255, - "name": "bytesreadrate", - "required": false, - "since": "4.15", - "type": "long" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "state of the disk offering", + "description": "VMware datacenter name.", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" + } + ], + "related": "addVmwareDc,listVmwareDcs", + "response": [ + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" }, + {}, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", - "type": "long" + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "since": "4.15", - "type": "long" + "description": "The VMware Datacenter name", + "name": "name", + "type": "string" }, + {}, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "since": "4.15", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.12.0" + }, + { + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", + "params": [ + { + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", "length": 255, - "name": "iopswriterate", + "name": "performfreshchecks", "required": false, - "since": "4.15", - "type": "long" + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering", + "description": "the ID of the router", "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", + "name": "routerid", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" + "description": "the id of the router", + "name": "healthchecks", + "type": "list" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "since": "4.15", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of the disk offering", + "description": "the id of the router", + "name": "routerid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "list control center", + "isasync": false, + "name": "listNetscalerControlCenter", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "sort key of the disk offering, integer", + "description": "", "length": 255, - "name": "sortkey", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "updates name of the disk offering with this value", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], - "related": "createDiskOffering,listDiskOfferings", + "related": "", "response": [ - {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "username", + "name": "username", + "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "num_retries", + "name": "numretries", + "type": "string" }, + {}, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "id", + "name": "id", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "ncc_ip", + "name": "ipaddress", + "type": "string" + }, + { + "description": "uuid", + "name": "uuid", + "type": "string" + }, + {} + ] + }, + { + "description": "Resizes a volume", + "isasync": true, + "name": "resizeVolume", + "params": [ + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + }, + { + "description": "New maximum number of IOPS", + "length": 255, + "name": "maxiops", + "required": false, "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "New volume size in GB", + "length": 255, + "name": "size", + "required": false, "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" + } + ], + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": "name of the availability zone", + "name": "zonename", "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the date this disk offering was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "io requests read rate of the disk offering", + "description": "IO requests read rate of the disk volume per the disk offering", "name": "diskIopsReadRate", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "state of the disk offering", - "name": "state", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "bytes read rate of the disk volume", "name": "diskBytesReadRate", "type": "long" }, - {}, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "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": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists IPv4 subnets for zone.", - "isasync": false, - "name": "listIpv4SubnetsForZone", - "params": [ + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, { - "description": "UUID of the IPv4 subnet.", - "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": false, - "type": "uuid" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, + {}, { - "description": "CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", - "length": 255, + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account associated with the disk volume", "name": "account", - "required": false, "type": "string" }, { - "description": "project who which the IPv4 subnet is dedicated to", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the domain ID which the IPv4 subnet is dedicated to.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "response": [ + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -32144,83 +29624,134 @@ "type": "integer" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the status of the volume", + "name": "status", "type": "string" }, - {} - ], - "since": "4.20.0" + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + {}, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + } + ] }, { - "description": "Adds account to a project", + "description": "Deletes affinity group", "isasync": true, - "name": "addAccountToProject", + "name": "deleteAffinityGroup", "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", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "ID of the project to add the account to", + "description": "the project of the affinity group", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, + "required": false, "type": "uuid" }, { - "description": "email to which invitation to the project is going to be sent", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "email", + "name": "name", "required": false, "type": "string" }, { - "description": "name of the account to be added to the project", + "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -32231,1500 +29762,1779 @@ "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {} - ], - "since": "3.0.0" + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { - "description": "Lists all available snapshots for the account.", + "description": "Deletes a network offering.", "isasync": false, - "name": "listSnapshots", + "name": "deleteNetworkOffering", "params": [ { - "description": "ID of the image or image cache store", + "description": "the ID of the network offering", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "valid values are MANUAL or RECURRING.", - "length": 255, - "name": "snapshottype", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "lists snapshot by snapshot ID", - "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", + "params": [ { - "description": "list snapshots by zone id", + "description": "the ID of the containing domain", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Pod", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" + } + ], + "related": "listDedicatedPods", + "response": [ + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", - "length": 255, - "name": "intervaltype", - "required": false, + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "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 dedicated resource", + "name": "id", "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": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" }, { - "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": "the Name of the Pod", + "name": "podname", + "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": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "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 ID of the Pod", + "name": "podid", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "UUID of storage network ip range", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "lists snapshot by snapshot name", + "description": "the beginning IP address", "length": 255, - "name": "name", + "name": "startip", "required": false, "type": "string" }, { - "description": "", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "pagesize", + "name": "vlan", "required": false, "type": "integer" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "the ending IP address", "length": 255, - "name": "locationtype", + "name": "endip", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "List by keyword", + "description": "the netmask for storage network", "length": 255, - "name": "keyword", + "name": "netmask", "required": false, "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" } ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "the gateway of the storage network IP range", + "name": "gateway", "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": "id of the os on volume", - "name": "ostypeid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, + {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", + "params": [ { - "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, + "description": "provider id", + "length": 255, + "name": "id", + "related": "createTungstenFabricProvider,listTungstenFabricProviders", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "state of the disk volume", - "name": "volumestate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "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": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "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": "Purge expunged resources", + "isasync": true, + "name": "purgeExpungedResources", + "params": [ { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "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 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": "startdate", + "required": false, + "type": "date" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" - }, + "description": "The size of batch used during purging", + "length": 255, + "name": "batchsize", + "required": false, + "type": "long" + } + ], + "response": [ {}, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" } - ] + ], + "since": "4.20" }, { - "description": "Reset site to site vpn connection", + "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": "resetVpnConnection", + "name": "changeOfferingForVolume", "params": [ { - "description": "an optional account for connection. Must be used with domainId.", + "description": "Verify OK to Shrink", "length": 255, - "name": "account", + "name": "shrinkok", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "id of vpn connection", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the volume", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, "type": "uuid" }, { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "miniops", "required": false, - "type": "uuid" - } - ], - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "response": [ - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" + "type": "long" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" - }, - {}, + "description": "New volume size in GB for the custom disk offering", + "length": 255, + "name": "size", + "required": false, + "type": "long" + } + ], + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ { - "description": "the project name", - "name": "project", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "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": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the date and time the host was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, - {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, + {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "State of vpn connection", - "name": "state", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - } - ] - }, - { - "description": "migrates resources from one secondary storage to destination image store", - "isasync": true, - "name": "migrateResourceToAnotherSecondaryStorage", - "params": [ + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + {}, { - "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" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", - "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "id(s) of the snapshots to be migrated", - "length": 255, - "name": "snapshots", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": false, - "type": "list" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "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" - } - ], - "related": "migrateSecondaryStorageData", - "response": [ + "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": "name of the disk offering", + "name": "diskofferingname", + "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 chain info of the volume", + "name": "chaininfo", + "type": "string" }, - {}, { - "description": "Type of migration requested for", - "name": "migrationtype", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a keypair by name", - "isasync": false, - "name": "deleteSSHKeyPair", - "params": [ - { - "description": "the project associated with keypair", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" }, { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the domain ID associated with the keypair", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "shared or local storage", + "name": "storagetype", "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 path of the volume", + "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "createAutoScaleVmGroup", - "params": [ - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" - }, - { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "length": 255, - "name": "maxmembers", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "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": "cluster name where the volume is allocated", + "name": "clustername", + "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.", - "length": 255, - "name": "minmembers", - "required": true, - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "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": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" - } - ], - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ - { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, - {}, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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 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": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "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", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "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 ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "state of the virtual machine", + "name": "vmstate", "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": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, - {}, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "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" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the public port", - "name": "publicport", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "Searches LDAP based on the username attribute", + "description": "Remove an Ldap Configuration", "isasync": false, - "name": "searchLdap", + "name": "deleteLdapConfiguration", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "port", "length": 255, - "name": "page", + "name": "port", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "linked domain", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "query to search using", + "description": "Hostname", "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", + "name": "hostname", "required": true, "type": "string" } ], - "related": "listLdapUsers", + "related": "addLdapConfiguration,listLdapConfigurations", "response": [ { - "description": "The user's lastname", - "name": "lastname", - "type": "string" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, { - "description": "The user's username", - "name": "username", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, + {}, { - "description": "The user's principle", - "name": "principal", + "description": "linked domain", + "name": "domainid", "type": "string" }, {}, { - "description": "The user's email", - "name": "email", + "description": "the UUID of the latest async job acting on 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 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" - }, - {}, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "The user's domain", - "name": "domain", - "type": "string" } ], "since": "4.2.0" }, { - "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", + "description": "Creates a Project role", "isasync": false, - "name": "readyForShutdown", + "name": "createProjectRole", "params": [ { - "description": "the uuid of the management server", + "description": "creates a project role with this unique name", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, "type": "uuid" + }, + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], - "related": "prepareForShutdown,triggerShutdown", + "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the name of the role", + "name": "name", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", "type": "boolean" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - } + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ], - "since": "4.19.0" + "since": "4.15.0" }, { - "description": "add a baremetal ping pxe server", + "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", "isasync": true, - "name": "addBaremetalPxePingServer", + "name": "createIpv6FirewallRule", "params": [ { - "description": "PING storage server ip", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "pingstorageserverip", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "Credentials to reach external pxe device", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "username", + "name": "protocol", "required": true, "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Password of PING storage server", + "description": "error code for this ICMP message", "length": 255, - "name": "pingcifspassword", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "URL of the external pxe device", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "url", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Pod Id", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Credentials to reach external pxe device", + "description": "type of the ICMP message being sent", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "Root directory on PING storage server", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "pingdir", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "Username of PING storage server", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "pingcifsusername", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "type of pxe device", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "Tftp root directory of PXE server", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "tftpdir", - "required": true, + "name": "traffictype", + "required": false, "type": "string" } ], - "related": "", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "url", - "name": "url", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "Root directory on PING storage server", - "name": "pingdir", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, + {}, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" } ] }, { - "description": "Change the BGP peers for a VPC.", - "isasync": true, - "name": "changeBgpPeersForVpc", + "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": "UUID of the VPC which the Bgp Peers are associated to.", + "description": "the uuid of the management server", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "managementserverid", + "related": "listManagementServers", "required": true, "type": "uuid" - }, - { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", - "length": 255, - "name": "bgppeerids", - "related": "listBgpPeers,updateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": false, - "type": "list" } ], - "related": "listBgpPeers,updateBgpPeer,releaseBgpPeer", + "related": "cancelShutdown,prepareForShutdown,readyForShutdown", "response": [ { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, + {}, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, + {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", + "description": "The id of the management server", + "name": "managementserverid", "type": "long" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", + "params": [ + { + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, - {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "length": 255, + "name": "displaynetwork", + "required": false, + "type": "boolean" + }, + { + "description": "Force update even if CIDR type is different", + "length": 255, + "name": "changecidr", + "required": false, + "type": "boolean" + }, + { + "description": "the new name for the network", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "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", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "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": "IPv4 address of bgp peer", - "name": "ipaddress", + "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": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "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" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the new display text for the network", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "length": 255, + "name": "guestvmcidr", + "required": false, "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ { - "description": "the ID of the load balancer rule", + "description": "the ID of the network", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "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": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" } ], + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "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" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" - } - ] - }, - { - "description": "Start a Shared FileSystem", - "isasync": true, - "name": "startSharedFileSystem", - "params": [ + }, { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, - "type": "uuid" - } - ], - "related": "createSharedFileSystem,listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "response": [ + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, { - "description": "the disk utilization", - "name": "utilization", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Name of the availability zone", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", "name": "zonename", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "state of the network", + "name": "state", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service 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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "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", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the account associated with the shared filesystem", + "description": "the owner of the network", "name": "account", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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" }, { @@ -33733,729 +31543,1016 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 project name of the shared filesystem", - "name": "project", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, - {}, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + } + ] + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", + "response": [ + { + "description": "Usage type ID", + "name": "id", + "type": "integer" + }, {}, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "Usage type name", + "name": "name", "type": "string" }, + {}, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "Usage type description", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a VPC", + "isasync": true, + "name": "deleteVPC", + "params": [ + { + "description": "the ID of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "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": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the shared filesystem'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": "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": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "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", + "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag key name", + "name": "key", "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": "id of the resource", + "name": "resourceid", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" - } - ], - "since": "4.20.0" - }, - { - "description": "list portable IP ranges", - "isasync": false, - "name": "listPortableIpRanges", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", - "required": false, - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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": "Id of a Region", - "length": 255, - "name": "regionid", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" - } - ], - "related": "createPortableIpRange", - "response": [ + }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the end ip of the portable IP range", - "name": "endip", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "portable IP range ID", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "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 ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" - } - ] - }, - { - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "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": "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 pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - {} - ], - "since": "4.4" - }, - { - "description": "Updates network permissions.", - "isasync": false, - "name": "createNetworkPermissions", - "params": [ { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "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": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Lists all configurations.", - "isasync": false, - "name": "listConfigurations", - "params": [ - { - "description": "the ID of the Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", - "length": 255, - "name": "subgroup", - "required": false, - "since": "4.18.0", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" + "description": "Base64 string containing the user data", + "name": "userdata", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "lists configuration by parent name (primarily used for UI)", - "length": 255, - "name": "parent", - "required": false, - "since": "4.18.0", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "lists configuration by name", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "lists configurations by category", - "length": 255, - "name": "category", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "lists configuration by group name (primarily used for UI)", - "length": 255, - "name": "group", - "required": false, - "since": "4.18.0", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - } - ], - "related": "updateConfiguration", - "response": [ + }, { - "description": "the value of the configuration", - "name": "id", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -34464,433 +32561,134 @@ "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, + {}, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", - "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": "any text associated with the success or failure", - "name": "displaytext", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "Assigns secondary IP to NIC", - "isasync": true, - "name": "addIpToNic", - "params": [ { - "description": "the ID of the nic to which you want to assign private IP", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the ID of the nic", - "name": "nicid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the network", - "name": "networkid", + "description": "the ID of the 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 vm", - "name": "virtualmachineid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, - { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { - "description": "the ID of the secondary private IP addr", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Stops a NetScalervm.", - "isasync": true, - "name": "stopNetScalerVpx", - "params": [ - { - "description": "the ID of the NetScaler vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (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 network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" - } - ], - "type": "list" - }, - { - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - {}, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "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 netmask of the nic", - "name": "netmask", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "device id for the network when plugged into the virtual machine", @@ -34898,113 +32696,103 @@ "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": "macaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the nic", + "name": "type", "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": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -35013,112 +32801,111 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "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", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "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": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" } ] }, { - "description": "Delete a Ucs manager", - "isasync": false, - "name": "deleteUcsManager", + "description": "Deletes a Kubernetes cluster", + "isasync": true, + "name": "deleteKubernetesSupportedVersion", "params": [ { - "description": "ucs manager id", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "id", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "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", @@ -35130,55 +32917,56 @@ "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": "Deletes a host.", + "description": "list baremetal rack configuration", "isasync": false, - "name": "deleteHost", + "name": "listBaremetalRct", "params": [ { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "", "length": 255, - "name": "forcedestroylocalstorage", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "List by keyword", "length": 255, - "name": "forced", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the host ID", + "description": "", "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "addBaremetalRct", "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "url", + "name": "url", + "type": "string" + }, + { + "description": "id of rct", + "name": "id", "type": "string" }, { @@ -35186,81 +32974,71 @@ "name": "jobid", "type": "string" }, + {}, {} ] }, { - "description": "Deletes a vm group", + "description": "Lists available certificate authority providers in CloudStack", "isasync": false, - "name": "deleteInstanceGroup", + "name": "listCAProviders", "params": [ { - "description": "the ID of the instance group", + "description": "List CA service provider by name", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the CA service provider name", + "name": "name", "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 description of the CA service provider", + "name": "description", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {} - ] + ], + "since": "4.11.0" }, { - "description": "deletes the resource icon from the specified resource(s)", - "isasync": false, - "name": "deleteResourceIcon", + "description": "Delete site to site vpn customer gateway", + "isasync": true, + "name": "deleteVpnCustomerGateway", "params": [ { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, - { - "description": "type of the resource", + "description": "id of customer gateway", "length": 255, - "name": "resourcetype", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -35270,236 +33048,306 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ], - "since": "4.16.0.0" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] }, { - "description": "Lists capabilities", + "description": "Lists all port forwarding rules for an IP address.", "isasync": false, - "name": "listCapabilities", - "params": [], - "related": "", - "response": [ + "name": "listPortForwardingRules", + "params": [ { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" - }, - { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "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": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" + "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": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", - "type": "integer" + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule", + "required": false, + "type": "uuid" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "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 retention time for Instances stats", - "name": "instancesstatsretentiontime", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of IP address of the port forwarding services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "true if users are allowed to force stop a vm, false otherwise", - "name": "allowuserforcestopvm", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "response": [ { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, - {}, - {}, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", - "type": "boolean" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" + "description": "the state of the rule", + "name": "state", + "type": "string" }, + {}, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "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": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the min CPU count for the service offering used by the shared filesystem instance", - "name": "sharedfsvmmincpucount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ] - }, - { - "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 Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "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": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" - }, + } + ] + }, + { + "description": "Allocates IP addresses in respective Pod of a Zone", + "isasync": false, + "name": "acquirePodIpAddress", + "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "the ID of the zone", "length": 255, - "name": "kvmnetworklabel", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "Pod ID", "length": 255, - "name": "xennetworklabel", + "name": "podid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "string" - }, - { - "description": "traffic type id", - "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" } ], - "related": "addTrafficType", + "related": "", "response": [ + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -35507,309 +33355,187 @@ "type": "string" }, { - "description": "id of the network provider", + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" + }, + {}, + { + "description": "the ID of the pod the IP address", "name": "id", - "type": "string" + "type": "long" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "type": "string" + "description": "the ID of the nic", + "name": "nicid", + "type": "long" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "CIDR of the Pod", + "name": "cidr", "type": "string" }, - {}, - {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Release dedication of zone", + "description": "Enables out-of-band management for a cluster", "isasync": true, - "name": "releaseDedicatedZone", + "name": "enableOutOfBandManagementForCluster", "params": [ { - "description": "the ID of the Zone", + "description": "the ID of the cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, - {} - ] - }, - { - "description": "List Conditions for VM auto scaling", - "isasync": false, - "name": "listConditions", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "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": "Counter-id of the condition.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "ID of the Condition.", - "length": 255, - "name": "id", - "related": "createCondition,listConditions", - "required": false, - "type": "uuid" - }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the out-of-band management driver for the host", + "name": "driver", "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 policy", - "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the out-of-band management interface username", + "name": "username", "type": "string" - } - ], - "related": "createCondition", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" - }, - { - "description": "the owner of the Condition.", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" - }, - { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" - }, - { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the project name of the Condition", - "name": "project", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Updates a network serviceProvider of a physical network", - "isasync": true, - "name": "updateNetworkServiceProvider", + "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": "Enabled/Disabled/Shutdown the physical network service provider", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "state", + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", "required": false, "type": "string" }, { - "description": "network service provider id", + "description": "the template ID", "length": 255, "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, { - "description": "the list of services to be enabled for this physical network service provider", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "servicelist", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "list" - } - ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { - "description": "the provider name", - "name": "name", - "type": "string" - }, + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + } + ], + "response": [ {}, { "description": "the UUID of the latest async job acting on this object", @@ -35817,220 +33543,237 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "true if operation 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": "Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only", + "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": "checkVolume", + "name": "resetPasswordForVirtualMachine", "params": [ { - "description": "parameter to repair the volume, leaks or all are the possible values", + "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "repair", + "name": "password", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "The ID of the volume", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, - {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "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 chain info of the volume", - "name": "chaininfo", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "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", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "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": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { @@ -36038,48 +33781,48 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -36088,483 +33831,910 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "ID of the availability zone", + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, + {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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 primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - } - ], - "since": "4.19.1" - }, - { - "description": "Lists Management Server metrics", - "isasync": false, - "name": "listManagementServersMetrics", - "params": [ - { - "description": "the id of the management server", - "length": 255, - "name": "id", - "related": "listManagementServers", - "required": false, - "type": "uuid" + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "include system level stats", - "length": 255, - "name": "system", - "related": "listManagementServersMetrics", - "required": false, - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "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": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the version of the management server", - "name": "version", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" - }, - {}, - { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the state of the management server", + "description": "the state of the virtual machine", "name": "state", - "type": "state" + "type": "string" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the current cpu load", - "name": "cpuload", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" - }, - { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" - }, - { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the 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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "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 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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the management server", - "name": "name", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Amount of memory used", - "name": "systemmemoryused", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", - "isasync": true, - "name": "removeFromLoadBalancerRule", + "description": "Lists Brocade VCS Switches", + "isasync": false, + "name": "listBrocadeVcsDevices", "params": [ { - "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", + "description": "List by keyword", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "Brocade VCS switch ID", "length": 255, - "name": "vmidipmap", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, - "since": "4.4", - "type": "map" + "type": "uuid" }, { - "description": "The ID of the load balancer rule", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { @@ -36573,98 +34743,83 @@ "type": "integer" }, {}, - {} - ] - }, - { - "description": "Lists vm groups", - "isasync": false, - "name": "listInstanceGroups", - "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 principal switch Ip address", + "name": "hostname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, + "description": "name of the provider", + "name": "provider", + "type": "string" + } + ] + }, + { + "description": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", + "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "domain admin username in LDAP ", "length": 255, - "name": "listall", + "name": "admin", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "The id of the domain which has to be linked to LDAP.", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "list instance groups by ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, "type": "uuid" }, { - "description": "list instance groups by name", + "description": "type of the ldap name. GROUP or OU", "length": 255, - "name": "name", - "required": false, + "name": "type", + "required": true, "type": "string" }, { - "description": "", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "page", - "required": false, + "name": "accounttype", + "required": true, "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ldapdomain", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "createInstanceGroup,updateInstanceGroup", + "related": "linkAccountToLdap", "response": [ { - "description": "the domain name of the instance group", - "name": "domain", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { @@ -36673,244 +34828,182 @@ "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Domain Admin accountId that is created", + "name": "accountid", + "type": "string" }, { - "description": "the domain ID of the instance group", + "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, { - "description": "the project name of the instance group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the instance group", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the ID of the instance group", - "name": "id", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" - }, - { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" } - ] + ], + "since": "4.6.0" }, { - "description": "migrates data objects from one secondary storage to destination image store(s)", - "isasync": true, - "name": "migrateSecondaryStorageData", + "description": "Setup the 2FA for the user.", + "isasync": false, + "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "id of the image store from where the data is to be migrated", + "description": "Enabled by default, provide false to disable 2FA", "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "name": "enable", + "required": false, + "type": "boolean" }, { - "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", + "description": "two factor authentication code", "length": 255, - "name": "migrationtype", + "name": "provider", "required": false, "type": "string" }, { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, - "name": "destpools", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "list" + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", + "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 account ID of the user", + "name": "accountid", + "type": "string" }, - {}, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the user name", + "name": "username", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user ID", + "name": "id", "type": "string" }, + {}, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.15.0" + "since": "4.18.0" }, { - "description": "Creates a static route", - "isasync": true, - "name": "createStaticRoute", + "description": "Lists site to site vpn customer gateways", + "isasync": false, + "name": "listVpnCustomerGateways", "params": [ { - "description": "the gateway id we are creating static route for", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { - "description": "static route cidr", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "cidr", - "required": true, - "type": "string" - } - ], - "related": "listStaticRoutes", - "response": [ - { - "description": "the project id of the static route", "name": "projectid", - "type": "string" + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the domain path associated with the static route", - "name": "domainpath", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, - {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the account associated with the static route", - "name": "account", - "type": "string" + "description": "id of the customer gateway", + "length": 255, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": false, + "type": "uuid" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the list of resource tags associated with static route", - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "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 associated with the static route", - "name": "domain", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", + "response": [ { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -36919,65 +35012,44 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the state of the static route", - "name": "state", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, {}, { - "description": "the ID of static route", - "name": "id", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" - } - ] - }, - { - "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,importVolume", - "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,importVolume", - "response": [ + "description": "the project id", + "name": "projectid", + "type": "string" + }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { @@ -36986,148 +35058,232 @@ "type": "integer" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", - "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 ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, + {}, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" + } + ] + }, + { + "description": "Deletes a Kubernetes cluster", + "isasync": true, + "name": "deleteKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", + "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" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Lists Webhooks", + "isasync": false, + "name": "listWebhooks", + "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "The scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The state of the Webhook", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "The name of the Webhook", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "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 volume has delete protection.", - "name": "deleteprotection", + "description": "The ID of the Webhook", + "length": 255, + "name": "id", + "related": "createWebhook,listWebhooks,listWebhookDeliveries", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "createWebhook,listWebhookDeliveries", + "response": [ + { + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { @@ -37135,370 +35291,590 @@ "name": "jobid", "type": "string" }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" + }, + { + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" + }, {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the project name of the Kubernetes cluster", + "name": "project", "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", + "name": "jobstatus", + "type": "integer" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "The state of the Webhook", + "name": "state", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "The name of the domain in which the Webhook exists", + "name": "domain", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a global load balancer rule", + "isasync": true, + "name": "createGlobalLoadBalancerRule", + "params": [ + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "region where the global load balancer is going to be created.", + "length": 255, + "name": "regionid", + "related": "addRegion,updateRegion,listRegions", + "required": true, + "type": "integer" + }, + { + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 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": "domain name for the GSLB service.", + "length": 255, + "name": "gslbdomainname", + "required": true, + "type": "string" + }, + { + "description": "GSLB service type (tcp, udp, http)", + "length": 255, + "name": "gslbservicetype", + "required": true, + "type": "string" + } + ], + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "response": [ + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, {}, { - "description": "the status of the volume", - "name": "status", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project id of the load balancer", + "name": "projectid", "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 bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "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": "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 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" + } + ], + "type": "list" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "tag key name", - "name": "key", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "ID of the disk volume", + "description": "global load balancer rule ID", "name": "id", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + } + ] + }, + { + "description": " delete a netscaler load balancer device", + "isasync": true, + "name": "deleteNetscalerLoadBalancer", + "params": [ { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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 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": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ] + }, + { + "description": "List resource tag(s)", + "isasync": false, + "name": "listTags", + "params": [ { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "list by value", + "length": 255, + "name": "value", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Adds traffic type to a physical network", - "isasync": true, - "name": "addTrafficType", - "params": [ - { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "list by customer name", "length": 255, - "name": "hypervnetworklabel", + "name": "customer", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "List by keyword", "length": 255, - "name": "xennetworklabel", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vmwarenetworklabel", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "list by key", "length": 255, - "name": "ovm3networklabel", + "name": "key", "required": false, "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "description": "", "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "kvmnetworklabel", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "isolationmethod", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "list by resource id", "length": 255, - "name": "vlan", + "name": "resourceid", "required": false, "type": "string" } ], - "related": "", + "related": "listResourceDetails", "response": [ { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "resource type", + "name": "resourcetype", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the network provider", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -37507,57 +35883,37 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a Private gateway", - "isasync": true, - "name": "deletePrivateGateway", - "params": [ - { - "description": "the ID of the private gateway", - "length": 255, - "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "tag key name", + "name": "key", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } - ] + ], + "since": "4.0.0" }, { - "description": "Lists the secondary storage selectors and their rules.", + "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": "listSecondaryStorageSelectors", + "name": "listAffectedVmsForStorageScopeChange", "params": [ + { + "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": "", "length": 255, @@ -37566,20 +35922,13 @@ "type": "integer" }, { - "description": "The zone ID to be used in the search filter.", + "description": "the Id of the storage pool on which change scope operation is being done", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" }, - { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -37587,13 +35936,6 @@ "required": false, "type": "integer" }, - { - "description": "Show removed heuristics.", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -37602,117 +35944,85 @@ "type": "string" } ], - "related": "createSecondaryStorageSelector,updateSecondaryStorageSelector", + "related": "", "response": [ { - "description": "Description of the heuristic.", - "name": "description", + "description": "the cluster ID for the VM", + "name": "clusterid", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, + {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "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": "the ID of the VM", + "name": "id", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "the cluster name for the VM", + "name": "clustername", + "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": "ID of the heuristic.", - "name": "id", + "description": "the name of the VM", + "name": "name", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "the type of VM", "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host ID for the VM", + "name": "hostid", + "type": "string" } ], - "since": "4.19.0" + "since": "4.19.1" }, { - "description": "List all virtual machine instances that are assigned to a load balancer rule.", - "isasync": false, - "name": "listLoadBalancerRuleInstances", + "description": "Create a virtual router element.", + "isasync": true, + "name": "createVirtualRouterElement", "params": [ { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", - "length": 255, - "name": "applied", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the load balancer rule", + "description": "the network service provider ID of the virtual router element", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": true, "type": "uuid" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", - "length": 255, - "name": "lbvmips", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "page", + "name": "providertype", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "listLoadBalancerRuleInstances", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "id", "type": "string" }, { @@ -37721,218 +36031,322 @@ "type": "integer" }, {}, - {}, { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" - } - ] - }, - { - "description": "Removes a condition for VM auto scaling", - "isasync": true, - "name": "deleteCondition", - "params": [ + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, { - "description": "the ID of the condition.", - "length": 255, - "name": "id", - "related": "createCondition", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", "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": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" } ] }, { - "description": "Updates a domain with a new name", - "isasync": false, - "name": "updateDomain", + "description": "Creates a VPC", + "isasync": true, + "name": "createVPC", "params": [ { - "description": "ID of domain to update", + "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": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", + "type": "string" }, { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "networkdomain", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "updates domain with this name", + "description": "the second IPv6 DNS for the VPC", "length": 255, - "name": "name", + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" - } - ], - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "response": [ - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "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 path of the domain", - "name": "path", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "The display text of the VPC, defaults to its 'name'.", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "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 projects being administrated by this domain", - "name": "projecttotal", + "description": "the AS Number of the VPC tiers", + "length": 255, + "name": "asnumber", + "required": false, + "since": "4.20.0", "type": "long" }, - {}, { - "description": "the name of the domain", - "name": "name", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the first IPv4 DNS for the VPC", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "Ids of the Bgp Peer for the VPC", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": false, + "since": "4.20.0", + "type": "list" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "the ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "create VPC for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the second IPv4 DNS for the VPC", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "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 total volume which can be used by this domain", - "name": "volumelimit", + "description": "the first IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the name of the VPC", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "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": "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 network domain", - "name": "networkdomain", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { @@ -37941,194 +36355,268 @@ "type": "boolean" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + {}, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" } ] }, { - "description": "Updates a physical network", + "description": "Removes detail for the Resource.", "isasync": true, - "name": "updatePhysicalNetwork", + "name": "removeResourceDetail", "params": [ { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "the VLAN for the physical network", + "description": "Delete detail by resource type", "length": 255, - "name": "vlan", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "physical network id", + "description": "Delete details for resource id", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", + "name": "resourceid", "required": true, - "type": "uuid" - }, - { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, "type": "string" }, { - "description": "Enabled/Disabled", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "state", + "name": "key", "required": false, "type": "string" } ], - "related": "createPhysicalNetwork", "response": [ + {}, { - "description": "isolation methods", - "name": "isolationmethods", - "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": "zone id of the physical network", - "name": "zoneid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -38136,464 +36624,809 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + } + ] + }, + { + "description": "Lists all supported OS types for this cloud.", + "isasync": false, + "name": "listOsTypes", + "params": [ { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, - {}, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "state of the physical network", - "name": "state", + "description": "list os by description", + "length": 255, + "name": "description", + "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Stop a Shared FileSystem", - "isasync": true, - "name": "stopSharedFileSystem", - "params": [ - { - "description": "Force stop the shared filesystem.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forced", + "name": "fordisplay", "required": false, + "since": "4.18.1", "type": "boolean" }, { - "description": "the ID of the shared filesystem", + "description": "list by Os Category id", "length": 255, - "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, "type": "uuid" } ], - "related": "createSharedFileSystem,listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "related": "addGuestOs", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "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", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "description of the shared filesystem", + "description": "the name/description of the OS type", "name": "description", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", + "description": "is the guest OS user defined", + "name": "isuserdefined", "type": "boolean" }, { - "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 availability zone", - "name": "zoneid", + "description": "the name of the OS type", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "Removes a Guest OS from listing.", + "isasync": true, + "name": "removeGuestOs", + "params": [ { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, + "description": "ID of the guest OS", + "length": 255, + "name": "id", + "related": "addGuestOs", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the state of the shared filesystem", - "name": "state", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "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": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.4.0" + }, + { + "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", + "isasync": true, + "name": "detachIso", + "params": [ { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "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": "ID of the storage fs vm", + "description": "The ID of the virtual machine", + "length": 255, "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "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": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 id the tag belongs to", + "name": "projectid", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account owning the security group", + "name": "account", "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 associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the type of the nic", + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "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 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" }, { @@ -38602,28 +37435,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -38632,425 +37465,455 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Disables an AutoScale Vm Group", - "isasync": true, - "name": "disableAutoScaleVmGroup", - "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "response": [ { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the date when this vm group was created", + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the account owning the vm group", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the project id of the vm group", + "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the group ID of the virtual machine", + "name": "groupid", + "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 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": "User VM type", + "name": "vmtype", "type": "string" }, {}, { - "description": "the private port", - "name": "privateport", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - } - ] - }, - { - "description": "Creates a snapshot policy for the account.", - "isasync": false, - "name": "createSnapshotPolicy", - "params": [ - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", - "length": 255, - "name": "schedule", - "required": true, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "Vm details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "maximum number of snapshots to retain", - "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, + "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 policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the disk volume", - "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,importVolume", - "required": true, - "type": "uuid" - } - ], - "related": "updateSnapshotPolicy", - "response": [ - { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "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": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Disables HA for a zone", - "isasync": true, - "name": "disableHAForZone", - "params": [ + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + {}, { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, - {}, - {} - ], - "since": "4.11" + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + } + ] }, { - "description": "Unmanage a volume on storage pool.", + "description": " delete a Palo Alto firewall device", "isasync": true, - "name": "unmanageVolume", + "name": "deletePaloAltoFirewall", "params": [ { - "description": "The ID of the volume to unmanage", + "description": "Palo Alto firewall device ID", "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,importVolume", + "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": "true if operation is executed successfully", @@ -39058,156 +37921,194 @@ "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" } - ], - "since": "4.19.1" + ] }, { - "description": "Adds an API permission to a role", + "description": "Executes a Webhook delivery", "isasync": false, - "name": "createRolePermission", + "name": "executeWebhookDelivery", "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", "length": 255, - "name": "permission", - "required": true, - "type": "string" + "name": "sslverification", + "required": false, + "type": "boolean" }, { - "description": "The API name or wildcard rule such as list*", + "description": "Payload of the Webhook delivery", "length": 255, - "name": "rule", - "required": true, + "name": "payload", + "required": false, "type": "string" }, { - "description": "The description of the role permission", + "description": "Payload URL of the Webhook delivery", "length": 255, - "name": "description", + "name": "payloadurl", "required": false, "type": "string" }, { - "description": "ID of the role", + "description": "The ID of the Webhook delivery for redelivery", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, + "name": "id", + "related": "executeWebhookDelivery", + "required": false, "type": "uuid" - } - ], - "related": "listRolePermissions", - "response": [ - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "Secret key of the Webhook delivery", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" + "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 role permission", - "name": "id", + "description": "The headers of the webhook delivery", + "name": "headers", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the role permission", - "name": "description", + "description": "The end time of the Webhook delivery", + "name": "enddate", + "type": "date" + }, + { + "description": "The name of the Webhook", + "name": "webhookname", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The ID of the Webhook", + "name": "webhookid", + "type": "string" + }, + { + "description": "The ID of the event", + "name": "eventid", + "type": "string" + }, + { + "description": "The payload of the webhook delivery", + "name": "payload", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the Webhook delivery", + "name": "id", + "type": "string" + }, + { + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The response of the webhook delivery", + "name": "response", + "type": "string" + }, + { + "description": "The type of the event", + "name": "eventtype", + "type": "string" + }, + { + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, + { + "description": "The name of the management server which executed delivery", + "name": "managementservername", + "type": "string" } ], - "since": "4.9.0" + "since": "4.20.0" }, { - "description": "List system virtual machines.", + "description": "Deletes a Pod.", "isasync": false, - "name": "listSystemVms", + "name": "deletePod", "params": [ { - "description": "the host ID of the system VM", + "description": "the ID of the Pod", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the system VM", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "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": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Lists Tungsten-Fabric providers", + "isasync": false, + "name": "listTungstenFabricProviders", + "params": [ { "description": "List by keyword", "length": 255, @@ -39218,20 +38119,12 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Pod ID of the system VM", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the Zone ID of the system VM", + "description": "", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -39239,611 +38132,586 @@ "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" } ], - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "related": "createTungstenFabricProvider", "response": [ { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "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", + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "type": "string" + "type": "long" }, - {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + } + ] + }, + { + "description": "Lists all DeploymentPlanners available.", + "isasync": false, + "name": "listDeploymentPlanners", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "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 ID of the system VM", - "name": "id", + "description": "Deployment Planner name", + "name": "name", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, + } + ] + }, + { + "description": "Deletes a cluster.", + "isasync": false, + "name": "deleteCluster", + "params": [ { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, + "description": "the cluster ID", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "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 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 gateway for the system VM", - "name": "gateway", + "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 Pod name for the system VM", - "name": "podname", - "type": "string" - }, + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "response": [ { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "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 job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - } - ] - }, - { - "description": "Creates a project", - "isasync": true, - "name": "createProject", - "params": [ - { - "description": "The display text of the project, defaults to the 'name´.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "name of the project", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "account who will be Admin for the project", - "length": 255, - "name": "account", - "required": false, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "ID of the account owning a project", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "domain ID of the account owning a project", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "response": [ - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, - {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the project", - "name": "name", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "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 available for this project to acquire", - "name": "vmavailable", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Assigns a certificate to a load balancer rule", - "isasync": true, - "name": "assignCertToLoadBalancer", + "description": "Removes specified region", + "isasync": false, + "name": "removeRegion", "params": [ { - "description": "the ID of the certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the load balancer rule", + "description": "ID of the region to delete", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "id", "required": true, - "type": "uuid" + "type": "integer" } ], "response": [ @@ -39852,6 +38720,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -39863,7 +38732,6 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -39872,84 +38740,170 @@ ] }, { - "description": "Detaches a disk volume from a virtual machine.", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates an existing autoscale vm group.", "isasync": true, - "name": "detachVolume", + "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the ID of the disk volume", + "description": "the ID of the autoscale group", "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,importVolume", - "required": false, + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, "type": "uuid" }, { - "description": "the ID of the virtual machine where the volume is detached from", + "description": "list of scaleup autoscale policies", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the device ID on the virtual machine where volume is detached from", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "deviceid", + "name": "fordisplay", "required": false, - "type": "long" + "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": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "type": "list" + }, + { + "description": "the frequency in which the performance counters to be collected", + "length": 255, + "name": "interval", + "required": false, + "type": "integer" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "length": 255, + "name": "minmembers", + "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 name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "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 status of the volume", - "name": "status", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { @@ -39958,1706 +38912,2271 @@ "type": "integer" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the project id of the vm group", + "name": "projectid", + "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "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 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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "List the virtual machines owned by the account.", + "isasync": false, + "name": "listVirtualMachines", + "params": [ { - "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 virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "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 ISO attached to the virtual machine", - "name": "isoname", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" }, - {}, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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": "type of the virtual machine", - "name": "vmtype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "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": "ID of the disk offering", - "name": "diskofferingid", - "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.16.0", + "type": "uuid" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", - "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "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": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", + "required": false, + "type": "uuid" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "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 disk utilization", - "name": "utilization", - "type": "string" + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "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": "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 path of the volume", - "name": "path", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - } - ] - }, - { - "description": "Replaces ACL associated with a network or private gateway", - "isasync": true, - "name": "replaceNetworkACLList", - "params": [ - { - "description": "the ID of the private gateway", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "userdata", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "the ID of the network", + "description": "list vms by affinity group", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "the ID of the network ACL", + "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": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" } ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 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 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": "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" }, { - "description": "Name of the account that is to be marked.", - "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": true, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, { - "description": "The Zone ID with which the account is to be marked.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the user name", - "name": "username", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" } ], - "type": "list" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - {}, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "type": "set" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "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 group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "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 total number of projects available for administration by this account", - "name": "projectavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "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 public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the id of the account", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + } + ], + "type": "set" }, { - "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 total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + {}, { - "description": "the state of the account", - "name": "state", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" - } - ], - "since": "4.0" - }, - { - "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,issueOutOfBandManagementPowerAction", - "response": [ + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the ID of the 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 out-of-band management interface username", + "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": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, - {}, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Lists LDAP Users according to the specifications from the user request.", - "isasync": false, - "name": "listLdapUsers", - "params": [ - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", - "length": 255, - "name": "listtype", - "required": false, - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "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", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { - "description": "The user's email", - "name": "email", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "The user's username", - "name": "username", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "the 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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", - "params": [ + }, { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "required": false, - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "The certificate serial number, as a hex value", - "length": 255, - "name": "serial", - "required": true, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, + "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" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {} - ], - "since": "4.11.0" + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + } + ] }, { - "description": "Deletes a routing firewall rule", - "isasync": true, - "name": "deleteRoutingFirewallRule", + "description": "Lists all available disk offerings.", + "isasync": false, + "name": "listDiskOfferings", "params": [ { - "description": "the ID of the Routing firewall rule", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "name": "storagetype", + "required": false, + "since": "4.19", + "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", - "isasync": false, - "name": "changeServiceForSystemVm", - "params": [ { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "details", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the service offering ID to apply to the system vm", + "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": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": false, + "since": "4.20.0", "type": "uuid" }, { - "description": "The ID of the system vm", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "id", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.17", "type": "uuid" - } - ], - "related": "migrateSystemVm,startSystemVm", - "response": [ - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "listed offerings support disk encryption", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "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 link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "length": 255, + "name": "volumeid", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "length": 255, + "name": "state", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "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" + } + ], + "related": "createDiskOffering", + "response": [ { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "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": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "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 public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, - {}, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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 private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": "the date this disk offering was created", + "name": "created", "type": "date" }, + {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "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", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "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": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" } ] }, { - "description": "Create VM Schedule", + "description": "Deletes a Cisco ASA 1000v appliance", "isasync": false, - "name": "createVMSchedule", + "name": "deleteCiscoAsa1000vResource", "params": [ { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "schedule", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": true, - "type": "string" - }, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", - "length": 255, - "name": "action", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Description of the schedule", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "ID of the VM for which schedule is to be defined", + "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 version for upgrade", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], - "related": "updateVMSchedule", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of VM schedule", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the id of the Kubernetes cluster", "name": "id", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "Date when the schedule was created", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", "name": "created", "type": "date" }, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" - } - ], - "since": "4.19.0" - }, - { - "description": "List the IP forwarding rules", - "isasync": false, - "name": "listIpForwardingRules", - "params": [ + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, { - "description": "Lists all rules applied to the specified 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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "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 name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "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": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list the rule belonging to this public IP address", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + {}, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "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": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", + "params": [ + { + "description": "ID of the Counter.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "the domain ID of the account.", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, + "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "an optional project for condition", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "threshold", + "required": true, + "type": "long" } ], - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "related": "listConditions", "response": [ { - "description": "the state of the rule", - "name": "state", + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" + }, { "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": "zone id of counter", + "name": "zoneid", "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 Counter.", + "name": "counterid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the id of the Condition", + "name": "id", "type": "string" }, + {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { @@ -41666,281 +41185,210 @@ "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, + {} + ] + }, + { + "description": "Lists projects and provides detailed information for listed projects", + "isasync": false, + "name": "listProjects", + "params": [ { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "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 vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "List projects by username", + "length": 255, + "name": "username", + "required": false, "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume.", - "isasync": true, - "name": "createSnapshot", - "params": [ + }, { - "description": "The ID of the disk volume", + "description": "list projects by state", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "type": "string" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "description": "list projects by name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "asynchronous backup if true", + "description": "list projects by project ID", "length": 255, - "name": "asyncbackup", + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "account", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the snapshot", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "description": "list projects by display text", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "displaytext", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "quiesce vm if true", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "quiescevm", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "locationtype", + "name": "tags", "required": false, - "type": "string" + "type": "map" } ], - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, - {}, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with vm", "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -41949,8 +41397,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" }, { @@ -41959,18 +41407,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -41979,82 +41427,92 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "set" + "type": "list" }, { - "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 cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "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 current status of the latest async job acting on this object", @@ -42062,1807 +41520,2188 @@ "type": "integer" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "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": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the 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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" - } + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + {} ], - "since": "4.2.0" + "since": "3.0.0" }, { - "description": "Lists storage pool metrics", + "description": "Creates an account", "isasync": false, - "name": "listStoragePoolsMetrics", + "name": "createAccount", "params": [ { - "description": "", + "description": "Unique username.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "username", + "required": true, + "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", + "description": "firstname", "length": 255, - "name": "storagecustomstats", - "required": false, - "since": "4.18.1", - "type": "boolean" + "name": "firstname", + "required": true, + "type": "string" }, { - "description": "the Pod ID for the storage pool", + "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": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the storage pool", + "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": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "name": "password", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "keyword", + "name": "accountid", "required": false, "type": "string" }, { - "description": "the storage pool path", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "path", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "lastname", "length": 255, - "name": "name", - "required": false, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "pagesize", + "name": "userid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the scope of the storage pool", + "description": "details for account used to store specific parameters", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" }, { - "description": "host ID of the storage pools", + "description": "email", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "name": "email", + "required": true, + "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "Network domain for the account's networks", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the status of the storage pool", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "status", + "name": "timezone", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "Creates the account under the specified role.", "length": 255, - "name": "ipaddress", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, - {}, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, + {}, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "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 timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + } + ], + "type": "list" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "details of the unmanage VM operation", - "name": "details", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" - } - ], - "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": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the date and time the router was created", + "description": "the date when this account was created", "name": "created", "type": "date" - }, + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "The ID of the vm snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 account associated with the router", - "name": "account", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "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 hostname for the router", - "name": "hostname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the router", - "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 first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - } - ] - }, - { - "description": "list the vm nics IP to NIC", - "isasync": false, - "name": "listNics", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 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": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the nic to list IPs", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "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 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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the nic", - "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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {} - ] - }, - { - "description": "Lists Bgp Peers.", - "isasync": false, - "name": "listBgpPeers", - "params": [ - { - "description": "AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, { - "description": "", - "length": 255, - "name": "pagesize", - "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, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "UUID of the Bgp Peer.", - "length": 255, - "name": "id", - "related": "listBgpPeers,updateBgpPeer,releaseBgpPeer", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of zone to which the Bgp Peer belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "project who which the Bgp Peer is dedicated to", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "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": "the domain ID which the Bgp Peer is dedicated to.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "updateBgpPeer,releaseBgpPeer", - "response": [ - {}, - { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "the domain name of the bgp peer", + "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "id of the bgp peer", - "name": "id", - "type": "string" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "AS number of bgp peer", - "name": "asnumber", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" - }, - { - "description": "password of bgp peer", - "name": "password", + "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", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Create a new keypair and returns the private key", - "isasync": false, - "name": "createSSHKeyPair", - "params": [ - { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "ID of the ssh keypair", - "name": "id", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { - "description": "Private key", - "name": "privatekey", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the owner of the keypair", - "name": "account", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the project name of the keypair owner", - "name": "project", + "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", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", - "isasync": true, - "name": "createSnapshotFromVMSnapshot", - "params": [ - { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" }, { - "description": "The 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,importVolume", - "required": true, - "type": "uuid" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "response": [ + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 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 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 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 gateway of the nic", + "name": "gateway", + "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 ID of the nic", + "name": "id", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Removes a Guest OS Mapping.", + "isasync": true, + "name": "removeGuestOsMapping", + "params": [ { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the guest OS mapping", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "ID of the snapshot", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": "Tungsten-Fabric service group start port", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "Tungsten-Fabric service group protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "name of the snapshot", + "description": "Tungsten-Fabric service group name", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, + "description": "Tungsten-Fabric service group end port", + "length": 255, + "name": "endport", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, + } + ] + }, + { + "description": "Recover a Shared FileSystem by id", + "isasync": false, + "name": "recoverSharedFileSystem", + "params": [ { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, + "description": "the ID of the shared filesystem to recover", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "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": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - } - ], - "since": "4.10.0" - }, - { - "description": "Authorizes a particular egress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupEgress", - "params": [ - { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "Register ISO for the project", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "securitygroupname", + "name": "isextractable", "required": false, + "type": "boolean" + }, + { + "description": "the name of the ISO", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "icmptype", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional project of the security group", + "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": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "error code for this icmp message", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "icmpcode", + "name": "passwordenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "start port for this egress rule", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "startport", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "end port for this egress rule", + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "endport", + "name": "bootable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "Image store UUID", "length": 255, - "name": "cidrlist", + "name": "imagestoreuuid", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "account", + "name": "directdownload", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "user to security group mapping", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "usersecuritygrouplist", + "name": "ispublic", "required": false, - "type": "map" + "type": "boolean" } ], - "related": "authorizeSecurityGroupIngress", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the list of resource tags associated with the rule", + "description": "checksum of the template", + "name": "checksum", + "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": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the size of the template", + "name": "size", + "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -43874,246 +43713,190 @@ "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, - {}, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "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": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, {}, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists storage pools.", - "isasync": false, - "name": "listStoragePools", - "params": [ + }, { - "description": "the status of the storage pool", - "length": 255, - "name": "status", - "required": false, + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", - "length": 255, - "name": "storagecustomstats", - "required": false, - "since": "4.18.1", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "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 zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the scope of the storage pool", - "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "host ID of the storage pools", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the storage pool path", - "length": 255, - "name": "path", - "required": false, + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the storage pool", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "response": [ + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the template name", + "name": "name", "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": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -44122,489 +43905,618 @@ "type": "boolean" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "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 project name of the template", + "name": "project", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + } + ] + }, + { + "description": "Lists Cisco ASA 1000v appliances", + "isasync": false, + "name": "listCiscoAsa1000vResources", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": false, + "type": "uuid" }, { - "description": "the storage pool path", - "name": "path", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, "type": "string" + } + ], + "related": "addCiscoAsa1000vResource", + "response": [ + {}, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {} + ] + }, + { + "description": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", + "params": [ { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Id of the portable ip range", + "length": 255, + "name": "id", + "related": "createPortableIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Upgrades router to use newer template", + "isasync": false, + "name": "upgradeRouterTemplate", + "params": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "upgrades all routers owned by the specified account", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "upgrades all routers within the specified zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers owned by the specified domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades router with the specified Id", + "length": 255, "name": "id", - "type": "string" + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": false, + "type": "uuid" }, { - "description": "the ID of the cluster for the storage pool", + "description": "upgrades all routers within the specified cluster", + "length": 255, "name": "clusterid", - "type": "string" + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "upgrades all routers within the specified pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the 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": "Updates a hypervisor capabilities.", + "description": "Lists IPv4 subnets for guest networks.", "isasync": false, - "name": "updateHypervisorCapabilities", + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "UUID of the IPv4 subnet for guest network.", "length": 255, - "name": "maxdatavolumeslimit", + "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "uuid" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "The CIDR of the Ipv4 subnet.", "length": 255, - "name": "storagemotionenabled", + "name": "subnet", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "UUID of network to which the IPv4 subnet is associated to.", "length": 255, - "name": "hypervisorversion", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.19.1", - "type": "string" + "type": "uuid" }, { - "description": "ID of the hypervisor capability", + "description": "UUID of VPC to which the IPv4 subnet is associated to.", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "", "length": 255, - "name": "maxhostspercluster", + "name": "pagesize", "required": false, - "since": "4.16.0", "type": "integer" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "vmsnapshotenabled", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "since": "4.19.1", - "type": "string" + "type": "integer" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "maxguestslimit", + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "List by keyword", "length": 255, - "name": "securitygroupenabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "listHypervisorCapabilities", + "related": "createIpv4SubnetForGuestNetwork", "response": [ { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + }, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", + "description": "id of the IPv4 subnet for guest network", "name": "id", "type": "string" }, + {}, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of subnet of the IPv4 network", + "name": "state", + "type": "string" }, { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Find hosts suitable for migrating a virtual machine.", - "isasync": false, - "name": "findHostsForMigration", - "params": [ + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "type": "string" + }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "subnet of the IPv4 network", + "name": "subnet", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "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,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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", + "type": "string" }, { - "description": "", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "the host ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, - {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, - {}, { - "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 host type", - "name": "type", - "type": "type" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "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 Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "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 the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "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 amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the cpu average load on the host", - "name": "averageload", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "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": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "the admin that annotated this host", + "name": "username", "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 amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -44613,9 +44525,14 @@ "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { "description": "the cluster name of the host", @@ -44623,52 +44540,180 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum 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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "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 last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", - "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": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" } ] }, { - "description": "Lists objects at specified path on an image store.", + "description": "Lists all VLAN IP ranges.", "isasync": false, - "name": "listImageStoreObjects", + "name": "listVlanIpRanges", "params": [ + { + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the VLAN IP range", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "network id of the VLAN IP range", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "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": "List by keyword", "length": 255, @@ -44677,18 +44722,34 @@ "type": "string" }, { - "description": "path to list on image store", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "path", + "name": "vlan", "required": false, "type": "string" }, { - "description": "", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "pagesize", + "name": "forvirtualnetwork", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "the ID of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "", @@ -44698,1315 +44759,897 @@ "type": "integer" }, { - "description": "id of the image store", + "description": "physical network id of the VLAN IP range", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" }, {}, + {}, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "Name of the data store object.", - "name": "name", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Return true if the specified account is allowed to create offerings with tags.", - "isasync": false, - "name": "isAccountAllowedToCreateOfferingsWithTags", - "params": [ + }, { - "description": "Account UUID", - "length": 255, + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "is domain admin allowed to create offerings with tags", - "name": "isallowed", - "type": "boolean" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, - {}, - {} + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Dedicates a guest vlan range to an account", + "description": "Updates a Zone.", "isasync": false, - "name": "dedicateGuestVlanRange", + "name": "updateZone", "params": [ { - "description": "domain ID of the account owning a VLAN", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "guest vlan range to be dedicated", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "vlanrange", - "required": true, + "name": "guestcidraddress", + "required": false, "type": "string" }, { - "description": "physical network ID of the vlan", + "description": "the first DNS for the Zone", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "dns1", + "required": false, + "type": "string" }, { - "description": "project who will own the VLAN", + "description": "the dns search order list", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "dnssearchorder", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "account who will own the VLAN", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "account", + "name": "internaldns1", "required": false, "type": "string" - } - ], - "related": "listDedicatedGuestVlanRanges", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "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", + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, "type": "string" }, - {}, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "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 project name of the guest vlan range", - "name": "project", - "type": "string" + "description": "sort key of the zone, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Adds VM to specified network by creating a NIC", - "isasync": true, - "name": "addNicToVirtualMachine", - "params": [ { - "description": "Network ID", + "description": "the ID of the Zone", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "the dhcp Provider for the Zone", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "dhcpprovider", + "required": false, + "type": "string" }, { - "description": "Mac Address for the new network", + "description": "the details for the Zone", "length": 255, - "name": "macaddress", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dhcpoptions", + "name": "localstorageenabled", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "IP Address for the new network", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "ipaddress", + "name": "ip6dns1", "required": false, "type": "string" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "createZone,listZones,listZones", "response": [ { - "description": "the ID of the virtual machine", + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "Zone id", "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "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 second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the capacity name", + "name": "name", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, + } + ], + "type": "list" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the domain associated with the tag", + "name": "domain", "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" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "Network domain name for the networks in the zone", "name": "domain", "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Zone description", + "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": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Extracts volume", + "isasync": true, + "name": "extractVolume", + "params": [ + { + "description": "the ID of the zone where the volume is located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the 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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" + } + ], + "related": "downloadImageStoreObject,extractIso,extractSnapshot,extractTemplate", + "response": [ { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the upload id of extracted object", + "name": "extractId", + "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": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 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": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "isasync": true, + "name": "releaseIpv4SubnetForZone", + "params": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "date when this IPv4 subnet was created.", "name": "created", "type": "date" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, + {}, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the domain ID of the IPv4 subnet", "name": "domainid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", + "description": "name of zone to which the IPv4 subnet belongs to.", "name": "zonename", "type": "string" }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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 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 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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists project's accounts", + "isasync": false, + "name": "listProjectAccounts", + "params": [ + { + "description": "list accounts of the project by account name", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "list accounts of the project by project role id", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "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" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "activateProject,createProject,suspendProject,updateProject", + "response": [ + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -46015,1240 +45658,1116 @@ "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ + }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "list static routes by state", - "length": 255, + "description": "the state of the project", "name": "state", - "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "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 public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "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 networks the project can own", + "name": "networklimit", + "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 total number of virtual machines deployed by this project", + "name": "vmtotal", + "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 total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of static route", - "name": "id", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, + {}, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain associated with the static route", + "description": "the domain name where the project belongs to", "name": "domain", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with static route", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the domain path associated with the static route", - "name": "domainpath", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "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 vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the state of the static route", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the static route", - "name": "project", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists all public ip addresses", - "isasync": false, - "name": "listPublicIpAddresses", + "description": "Updates an existing autoscale policy.", + "isasync": true, + "name": "updateAutoScalePolicy", "params": [ { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" - }, - { - "description": "lists IP address by ID", + "description": "the ID of the autoscale policy", "length": 255, "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, "type": "uuid" }, { - "description": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "lists all public IP addresses by zone ID", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "quiettime", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists all public IP addresses by source network ID", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "conditionids", + "related": "listConditions", "required": false, - "since": "4.13.0", - "type": "uuid" + "type": "list" }, { - "description": "list only source NAT IP addresses", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "issourcenat", + "name": "duration", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the autoscale policy", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" - }, + } + ], + "related": "listAutoScalePolicies", + "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 project name of the autoscale policy", + "name": "project", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", + "type": "string" }, { - "description": "lists the specified IP address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "lists all public IP addresses associated to the network specified", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the domain name of the autoscale policy", + "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": "the autoscale policy ID", + "name": "id", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the domain ID of the autoscale policy", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "true if range is dedicated for system VMs", - "length": 255, - "name": "forsystemvms", - "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "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": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "description": "name of the autoscale policy", + "name": "name", "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 resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + } + ] + }, + { + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", + "params": [ + { + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list only IPs used for load balancing", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "forloadbalancing", + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only static NAT IP addresses", + "description": "The CIDR of the IPv4 subnet.", "length": 255, - "name": "isstaticnat", - "required": false, - "type": "boolean" + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "UUID of the zone which the IPv4 subnet belongs to.", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" } ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the project name of the IPv4 subnet", + "name": "project", "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": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "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" - } - ], - "type": "list" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a disk offering.", + "isasync": false, + "name": "createDiskOffering", + "params": [ { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" }, { - "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 containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "whether disk offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, "type": "boolean" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "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": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "Volumes using this offering should be encrypted", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" + "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 name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "min iops of the disk offering", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "whether disk offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" }, { - "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,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "list" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Updates an ISO file.", - "isasync": false, - "name": "updateIso", - "params": [ - { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "bootable", + "name": "iopswriterate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "the format for the image", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "format", + "name": "disksize", "required": false, - "type": "string" + "type": "long" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "requireshvm", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "arch", + "name": "cachemode", "required": false, - "since": "4.20", + "since": "4.14", "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "max iops of the disk offering", "length": 255, - "name": "cleanupdetails", + "name": "maxiops", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the name of the image file", - "length": 255, - "name": "name", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "sort key of the template, integer", + "description": "length (in seconds) of the burst", "length": 255, - "name": "sortkey", + "name": "iopswriteratemaxlength", "required": false, - "type": "integer" + "type": "long" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "details", + "name": "bytesreadrate", "required": false, - "type": "map" + "type": "long" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "length (in seconds) of the burst", "length": 255, - "name": "passwordenabled", + "name": "iopsreadratemaxlength", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "storagetype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "isrouting", + "name": "provisioningtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "isdynamicallyscalable", + "name": "displayoffering", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "details to specify disk offering parameters", "length": 255, - "name": "sshkeyenabled", + "name": "details", "required": false, - "type": "boolean" - }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "since": "4.16", + "type": "map" } ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "", "response": [ { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "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 processor bit size", - "name": "bits", - "type": "int" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "the size of the template", - "name": "size", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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 name of the domain to which the template belongs", - "name": "domain", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the template ID", - "name": "id", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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 account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "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": "the type of the template", - "name": "templatetype", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, - {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "state of the disk offering", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the status of the template", - "name": "status", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + } + ] + }, + { + "description": "Lists details of network protocols", + "isasync": false, + "name": "listNetworkProtocols", + "params": [ + { + "description": "The option of network protocols. Supported values are: protocolnumber, icmptype.", + "length": 255, + "name": "option", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" }, { - "description": "the project name of the template", - "name": "project", + "description": "the description of the protocol parameter", + "name": "description", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the protocol parameter", + "name": "name", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", + "name": "index", + "type": "integer" }, + {}, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Lists load balancer health check policies.", + "isasync": false, + "name": "listLBHealthCheckPolicies", + "params": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "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", - "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 ID of the health check policy", + "length": 255, + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" - }, + } + ], + "related": "createLBHealthCheckPolicy", + "response": [ + {}, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" } ], - "type": "set" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - } - ] - }, - { - "description": "Lists OpenDyalight controllers", - "isasync": false, - "name": "listOpenDaylightControllers", - "params": [ - { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ - { - "description": "the name assigned to the controller", - "name": "name", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, {}, { - "description": "the url of the controller api", - "name": "url", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -47257,304 +46776,411 @@ "type": "integer" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {}, - { - "description": "device id of the controller", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Adds a BigSwitch BCF Controller device", + "description": "Attempts Migration of a VM with its volumes to a different host", "isasync": true, - "name": "addBigSwitchBcfDevice", + "name": "migrateVirtualMachineWithVolume", "params": [ { - "description": "Password of the BigSwitch BCF Controller.", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "NAT support of the BigSwitch BCF Controller.", + "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": "nat", - "required": true, - "type": "boolean" + "name": "migrateto", + "required": false, + "type": "map" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "autoselect", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "the ID of the virtual machine", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "related": "listBigSwitchBcfDevices", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "response": [ - {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "NAT support", - "name": "nat", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - } - ], - "since": "4.6.0" - }, - { - "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,listCounters", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "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 ID of the affinity group", + "name": "id", + "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "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": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ - { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -47563,109 +47189,89 @@ "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "ssh key-pairs", + "name": "keypairs", "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the 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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "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 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", @@ -47676,13 +47282,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -47691,13 +47297,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -47706,18 +47312,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -47729,13 +47335,13 @@ "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "the 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 protocol of the security group rule", @@ -47743,37 +47349,47 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "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" }, { @@ -47782,13 +47398,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -47797,13 +47413,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -47814,11 +47435,6 @@ ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", @@ -47830,84 +47446,39 @@ "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 starting IP of the security group rule", + "name": "startport", "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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": "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 ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -47916,58 +47487,63 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -47988,11 +47564,6 @@ "name": "startport", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", @@ -48006,74 +47577,151 @@ "name": "domainid", "type": "string" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the 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 format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the 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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the VM's disk write in KiB", @@ -48081,24 +47729,34 @@ "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": " an 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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "the id of userdata used for the VM", @@ -48106,1555 +47764,1170 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the 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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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": "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": "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": "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": "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the 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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" } ] }, { - "description": "Generate DRS plan for a cluster", + "description": "Updates a user account", "isasync": false, - "name": "generateClusterDrsPlan", + "name": "updateUser", "params": [ { - "description": "the ID of the Cluster", + "description": "last name", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "name": "lastname", + "required": false, + "type": "string" }, { - "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "migrations", + "name": "timezone", "required": false, - "type": "integer" - } - ], - "related": "executeClusterDrsPlan", - "response": [ - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, - {}, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "first name", + "length": 255, + "name": "firstname", + "required": false, "type": "string" }, - {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "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": "mandate2fa", + "required": false, + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "length": 255, + "name": "currentpassword", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", + "required": false, + "type": "string" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "email", + "length": 255, + "name": "email", + "required": false, "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", + "description": "User uuid", "length": 255, "name": "id", "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": true, "type": "uuid" + }, + { + "description": "Unique username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "The secret key for the user. Must be specified with userApiKey", + "length": 255, + "name": "usersecretkey", + "required": false, + "type": "string" } ], + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, - {} - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", - "response": [ - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the user firstname", + "name": "firstname", "type": "string" }, {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the user lastname", + "name": "lastname", + "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 account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "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": "the out-of-band management interface username", - "name": "username", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the operation result", - "name": "status", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {} - ], - "since": "4.9.0" + {}, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + } + ] }, { - "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "description": "Removes a certificate from a load balancer rule", "isasync": true, - "name": "createSharedFileSystem", + "name": "removeCertFromLoadBalancer", "params": [ { - "description": "the name of the shared filesystem.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "name", + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, - "type": "string" + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", - "length": 255, - "name": "filesystem", - "required": true, + "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": "the description for the shared filesystem.", + "description": "the host URL", "length": 255, - "name": "description", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "description": "the cluster ID for the host", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the zone id.", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "type": "string" }, { - "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", + "description": "hypervisor type of the host", "length": 255, - "name": "provider", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "min iops", + "description": "list of tags to be added to the host", "length": 255, - "name": "miniops", + "name": "hosttags", "required": false, - "type": "long" + "type": "list" }, { - "description": "network to attach the shared filesystem to", + "description": "the Zone ID for the host", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "max iops", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "maxiops", + "name": "username", "required": false, - "type": "long" + "type": "string" }, { - "description": "the size of the shared filesystem in GiB", + "description": "the Pod ID for the host", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "description": "the cluster name for the host", "length": 255, - "name": "account", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", - "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 account associated with the shared filesystem", - "name": "account", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "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": "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": "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": "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 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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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": "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": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the 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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - } - ], - "type": "list" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Issues a client certificate using configured or provided CA plugin", - "isasync": true, - "name": "issueCertificate", - "params": [ + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, { - "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", - "length": 255, - "name": "domain", - "required": false, - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", - "required": false, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" - } - ], - "related": "listCaCertificate", - "response": [ + }, { - "description": "The client certificate", - "name": "certificate", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } - ], - "since": "4.11.0" + ] }, { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", "params": [ { - "description": "Id of network device to delete", + "description": "the ID of the disk volume", "length": 255, "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "related": "importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" + }, + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Updates image store read-only status", - "isasync": false, - "name": "updateImageStore", - "params": [ + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, { - "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", - "length": 255, - "name": "capacitybytes", - "required": false, + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", - "length": 255, - "name": "readonly", - "required": false, - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "Image Store UUID", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "The new name for the Image Store.", - "length": 255, - "name": "name", - "required": false, + "description": "pod name of the volume", + "name": "podname", "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - {}, + }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, {}, { - "description": "the name of the image store", - "name": "name", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - } - ], - "since": "4.15.0" - }, - { - "description": "Creates a port forwarding rule", - "isasync": true, - "name": "createPortForwardingRule", - "params": [ + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, { - "description": "the starting port of port forwarding rule's public port range", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when 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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, - "type": "integer" + "description": "the project name of the vpn", + "name": "project", + "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).", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the project id of the vpn", + "name": "projectid", + "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": "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 for the port forwarding rule", - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "privateendport", - "required": false, - "type": "integer" - } - ], - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the ID of the 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 public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with the rule", + "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 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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -49663,18 +48936,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -49683,305 +48956,301 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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" } ], - "type": "list" + "type": "set" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, - {}, - {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "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": "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": "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" - } - ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the tag of this template", - "name": "templatetag", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "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", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + } + ] + }, + { + "description": "Updates a project", + "isasync": true, + "name": "updateProject", + "params": [ + { + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "length": 255, + "name": "swapowner", + "required": false, "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "ID of the user to be promoted/demoted", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "Account level role to be assigned to the user/account : Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, "type": "string" }, { - "description": "the template name", + "description": "name of the project", + "length": 255, "name": "name", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "display text of the project", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, + "description": "new Admin account for the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "activateProject,createProject,suspendProject", + "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the template ID", - "name": "id", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "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": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the date this template was removed", - "name": "removed", + "description": "the date this project was created", + "name": "created", "type": "date" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -49989,52 +49258,163 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, + {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the list of resource tags associated", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "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 domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "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 domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -50043,8 +49423,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -50053,238 +49433,120 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the project name of the template", - "name": "project", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", + "description": "Lists internal load balancers", + "isasync": false, + "name": "listLoadBalancers", "params": [ { - "description": "the ID of the containing domain", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the ID of the zone", + "description": "the name of the load balancer", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", - "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 Zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", - "params": [ { - "description": "the ID of the load balancer rule", + "description": "the network ID of the source IP address", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": true, + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "vmidipmap", + "name": "listall", "required": false, - "since": "4.4", - "type": "map" + "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)", + "description": "the network ID of the load balancer", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "list" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "type": "uuid" }, - {} - ] - }, - { - "description": "Lists all pending asynchronous jobs for the account.", - "isasync": false, - "name": "listAsyncJobs", - "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the source IP address of the load balancer", "length": 255, - "name": "listall", + "name": "sourceipaddress", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -50294,180 +49556,302 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The id of the management server", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "isrecursive", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the load balancer", "length": 255, - "name": "pagesize", + "name": "id", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "startdate", + "name": "fordisplay", "required": false, - "type": "date" + "since": "4.4", + "type": "boolean" } ], - "related": "queryAsyncJobResult", + "related": "createLoadBalancer", "response": [ { - "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 account of the Load Balancer", + "name": "account", + "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, - {}, { - "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" }, { - "description": "the async command executed", - "name": "cmd", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, - {}, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "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 result reason", - "name": "jobresult", - "type": "responseobject" + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + } + ], + "type": "list" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Archive one or more alerts.", + "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": "archiveAlerts", + "name": "registerUserKeys", "params": [ { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "User id", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "getUserKeys", + "response": [ + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" }, + {}, { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", - "required": false, - "type": "list" + "description": "the api key of the registered user", + "name": "apikey", + "type": "string" }, { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "archive by alert type", - "length": 255, - "name": "type", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + {} + ] + }, + { + "description": "Deletes a load balancer stickiness policy.", + "isasync": true, + "name": "deleteLBStickinessPolicy", + "params": [ + { + "description": "the ID of the LB stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": true, + "type": "uuid" } ], "response": [ @@ -50477,12 +49861,6 @@ "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", @@ -50492,353 +49870,306 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists all Buckets.", + "description": "Lists site to site vpn connection gateways", "isasync": false, - "name": "listBuckets", + "name": "listVpnConnections", "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 name of the bucket", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the bucket", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listBuckets", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "id of the vpn connection", "length": 255, - "name": "tags", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ids", - "related": "listBuckets", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "id of vpc", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "", + "related": "createVpnConnection,updateVpnConnection", "response": [ { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" - }, - { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, - {}, { - "description": "Bucket URL", - "name": "url", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" - } - ], - "since": "4.19.0" + }, + { + "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": "Creates a secondary storage selector, described by the heuristic rule.", - "isasync": false, - "name": "createSecondaryStorageSelector", + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicy", "params": [ { - "description": "The zone in which the heuristic rule will be applied.", + "description": "the ID of zone", "length": 255, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "The name identifying the heuristic rule.", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "name", + "name": "policyuuid", "required": true, "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "type", + "name": "networkuuid", "required": true, "type": "string" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "The description of the heuristic rule.", - "length": 255, - "name": "description", - "required": true, + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } - ], - "related": "updateSecondaryStorageSelector", - "response": [ + }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -50846,587 +50177,945 @@ "type": "integer" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {} + ] + }, + { + "description": "Migrate current NFS secondary storages to use object store.", + "isasync": false, + "name": "updateCloudToUseObjectStore", + "params": [ + { + "description": "the image store provider name", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "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 URL for the image store", + "length": 255, + "name": "url", + "required": false, "type": "string" }, - {}, { - "description": "Name of the heuristic.", + "description": "the name for the image store", + "length": 255, "name": "name", + "required": false, "type": "string" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "response": [ + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "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" } ], - "since": "4.19.0" + "since": "4.3.0" }, { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", + "description": "Creates a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "createASNRange", "params": [ { - "description": "the ID of the internal lb vm", + "description": "the zone ID", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "name": "zoneid", + "related": "createZone,listZones,listZones", "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": "the start AS Number", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "startasn", + "required": true, + "type": "long" + }, + { + "description": "the end AS Number", + "length": 255, + "name": "endasn", + "required": true, + "type": "long" } ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "related": "listASNRanges", "response": [ { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "End AS Number", + "name": "endasn", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "ID of the AS Number Range", + "name": "id", "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": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "Start AS Number", + "name": "startasn", + "type": "long" }, + {}, { - "description": "the second DNS for the router", - "name": "dns2", + "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": "Created date", + "name": "created", + "type": "date" + } + ], + "since": "4.20.0" + }, + { + "description": "add Tungsten-Fabric network gateway to logical router", + "isasync": true, + "name": "addTungstenFabricNetworkGatewayToLogicalRouter", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" + } + ], + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", + "response": [ + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "description": "the Zone name for the router", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {} + ] + }, + { + "description": "list Tungsten-Fabric nic", + "isasync": false, + "name": "listTungstenFabricNic", + "params": [ { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, "type": "string" }, { - "description": "the Zone ID for the router", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, "name": "zoneid", - "type": "string" + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric nic name", + "name": "name", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" }, + {} + ] + }, + { + "description": "Retrieves VMware DC(s) associated with a zone.", + "isasync": false, + "name": "listVmwareDcs", + "params": [ { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Id of the CloudStack zone.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addVmwareDc", + "response": [ + { + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" + } + ] + }, + { + "description": "apply Tungsten-Fabric policy", + "isasync": true, + "name": "applyTungstenFabricPolicy", + "params": [ + { + "description": "the major sequence of Tungsten-Fabric policy", + "length": 255, + "name": "majorsequence", + "required": true, + "type": "integer" }, { - "description": "role of the domain router", - "name": "role", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the minor sequence of Tungsten-Fabric policy", + "length": 255, + "name": "minorsequence", + "required": true, + "type": "integer" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the uuid of network", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "the 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", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, + {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Lists zones", + "isasync": false, + "name": "listZones", + "params": [ + { + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "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": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the ID of the zone", + "length": 255, + "name": "id", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "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.", + "length": 255, + "name": "available", + "required": false, + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "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": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createZone,listZones", + "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, - {}, { - "description": "the template name for the router", - "name": "templatename", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "Type of adapter if available", - "name": "adaptertype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "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 name of the corresponding network", - "name": "networkname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + {}, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the domain associated with the router", + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", "name": "domain", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, + {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the allocation state of the cluster", + "name": "allocationstate", "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": "the name of the router", + "description": "Zone name", "name": "name", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "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": "the guest netmask for the router", - "name": "guestnetmask", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" } ] }, { - "description": "Adds a Brocade VCS Switch", - "isasync": true, - "name": "addBrocadeVcsDevice", + "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "isasync": false, + "name": "removeQuarantinedIp", "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.", + "description": "The reason for removing the public IP address from quarantine prematurely.", "length": 255, - "name": "hostname", + "name": "removalreason", "required": true, "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "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": "password", - "required": true, - "type": "string" + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "required": false, + "type": "uuid" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "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": "username", - "required": true, + "name": "ipaddress", + "required": false, "type": "string" } ], - "related": "listBrocadeVcsDevices", + "related": "listQuarantinedIps,updateQuarantinedIp", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" + }, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, {}, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { @@ -51434,197 +51123,139 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, - {}, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" } - ] + ], + "since": "4.19" }, { - "description": "Updates a security group", + "description": "Releases a Public IP range back to the system pool", "isasync": false, - "name": "updateSecurityGroup", + "name": "releasePublicIpRange", "params": [ { - "description": "The ID of the security group.", + "description": "the id of the Public IP range", "length": 255, "name": "id", - "related": "createSecurityGroup,updateSecurityGroup", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The new name of the security group.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "createSecurityGroup", - "response": [ - {}, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the description of the security group", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "lists network that are using a netscaler load balancer device", + "isasync": false, + "name": "listNetscalerLoadBalancerNetworks", + "params": [ { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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 name of the security group", - "name": "domain", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, + {}, { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the project id of the group", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, @@ -51634,151 +51265,167 @@ "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", "type": "set" }, { - "description": "the name of the security group", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the name of the network", "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -51787,28 +51434,28 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -51817,953 +51464,912 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the security group", - "name": "id", - "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 network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, - {}, { - "description": "the project name of the group", - "name": "project", - "type": "string" - } - ], - "since": "4.14.0.0" - }, - { - "description": "Creates a domain", - "isasync": false, - "name": "createDomain", - "params": [ + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, { - "description": "Network domain for networks in the domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "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" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "Domain UUID, required for adding domain from another Region", - "length": 255, + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the domain id of the network owner", "name": "domainid", - "required": false, "type": "string" }, { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" - } - ], - "related": "listDomainChildren,listDomains,listDomains", - "response": [ + }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, { "description": "the network domain", "name": "networkdomain", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the level of the domain", - "name": "level", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, { - "description": "the state of the domain", - "name": "state", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" - }, - {}, + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + } + ] + }, + { + "description": "create Tungsten-Fabric public network", + "isasync": false, + "name": "createTungstenFabricPublicNetwork", + "params": [ { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" - }, + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, + {}, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "operation status", + "name": "status", + "type": "boolean" }, + {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "Deleting resource tag(s)", - "isasync": true, - "name": "deleteTags", + "description": "Lists supported methods of network isolation", + "isasync": false, + "name": "listNetworkIsolationMethods", "params": [ { - "description": "Delete tag by resource type", + "description": "List by keyword", "length": 255, - "name": "resourcetype", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Delete tags matching key/value pairs", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "Delete tags for resource id(s)", + "description": "", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "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": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {} ], - "since": "4.0.0" + "since": "4.2.0" }, { - "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", + "description": "list Tungsten-Fabric firewall policy", + "isasync": false, + "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "Turn the network into a network with redundant routers.", + "description": "List by keyword", "length": 255, - "name": "makeredundant", + "name": "keyword", "required": false, - "since": "4.11.1", - "type": "boolean" + "type": "string" }, { - "description": "The ID of the network to restart.", + "description": "", "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, "type": "uuid" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "livepatch", + "name": "applicationpolicysetuuid", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "string" }, { - "description": "If cleanup old network elements", + "description": "", "length": 255, - "name": "cleanup", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], + "related": "createTungstenFabricFirewallPolicy", "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": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, - {} - ] - }, - { - "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, - "name": "username", - "required": true, + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", - "length": 255, - "name": "domain", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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.", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "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": "domainId", + "name": "cleanup", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "ID of domain to delete", "length": 255, - "name": "password", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", "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": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" - }, - { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" - }, - { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" - }, - { - "description": "user time zone", - "name": "timezone", - "type": "string" - }, - { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" - }, - { - "description": "the account name the user belongs to", - "name": "account", + "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 account type (admin, domain-admin, read-only-admin, user)", - "name": "type", - "type": "string" - }, - { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" - }, - { - "description": "Username", - "name": "username", - "type": "string" - }, - { - "description": "User ID", - "name": "userid", - "type": "string" - }, - { - "description": "first name of the user", - "name": "firstname", - "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": "last name of the user", - "name": "lastname", - "type": "string" - }, - {}, - { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "Is user registered", - "name": "registered", - "type": "string" - }, - { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", - "type": "string" - } + {} ] }, { - "description": "Lists all hypervisor capabilities.", - "isasync": false, - "name": "listHypervisorCapabilities", + "description": "Migrate volume", + "isasync": true, + "name": "migrateVolume", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "destination storage pool ID to migrate the volume to", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "if the volume should be live migrated when it is attached to a running vm", "length": 255, - "name": "hypervisor", + "name": "livemigrate", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "ID of the hypervisor capability", + "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": "id", - "related": "listHypervisorCapabilities", + "name": "newdiskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the volume", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" + "description": "the 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 project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ - { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the URL for the image store", - "length": 2048, - "name": "url", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "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 scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - {}, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Revoke a direct download certificate from hosts in a zone", - "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", - "params": [ { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "(optional) hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "id of the certificate", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "(optional) zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "provisionTemplateDirectDownloadCertificate", - "response": [ - { - "description": "the name of the host", - "name": "hostname", + "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the state of the disk volume", + "name": "state", "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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "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 total disk size of the storage pool", - "name": "disksizetotal", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -52772,140 +52378,165 @@ "type": "integer" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" } ], - "since": "4.16.0" + "since": "3.0.0" }, { - "description": "Delete Project roles in CloudStack", - "isasync": false, - "name": "deleteProjectRole", + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", "params": [ { - "description": "ID of the project role to be deleted", + "description": "Tungsten-Fabric application policy set name", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "ID of the project from where the role is to be deleted", + "description": "the ID of zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" } ], + "related": "", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, {}, @@ -52915,244 +52546,315 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" } - ], - "since": "4.15.0" + ] }, { - "description": "Changes ownership of a Volume from one account to another.", - "isasync": false, - "name": "assignVolume", + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", "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 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" - }, - { - "description": "The ID of the volume to be reassigned.", + "description": "Id of the Bgp Peer", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": true, "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "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": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", + "params": [ { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Hypervisor type of the resource", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost", + "response": [ { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the ID of the host", + "name": "hostid", "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": "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": "ID of the disk offering", - "name": "diskofferingid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "operation status", + "name": "status", "type": "boolean" }, + {} + ], + "since": "4.11" + }, + { + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", + "params": [ { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the time the event was entered", + "length": 255, + "name": "entrytime", + "required": false, + "type": "integer" }, { - "description": "pod id of the volume", - "name": "podid", - "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": "cluster name where the volume is allocated", - "name": "clustername", - "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": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.0", + "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": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the event type (see event types)", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the event level (INFO, WARN, ERROR)", + "length": 255, + "name": "level", + "required": false, "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the type of the resource associated with the event", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true to list archived events otherwise false", + "length": 255, + "name": "archived", + "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "length": 255, + "name": "startid", + "related": "listEvents", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the ID of the event", + "length": 255, + "name": "id", + "related": "listEvents", + "required": false, + "type": "uuid" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "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 template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the duration of the event", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", - "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 date the disk volume was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "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" + } + ], + "related": "", + "response": [ + { + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project name of the address", + "name": "project", "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the id of the account's domain", + "name": "domainid", "type": "string" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the state of the event", + "name": "state", + "type": "state" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "whether the event has been archived or not", + "name": "archived", "type": "boolean" }, { @@ -53161,321 +52863,149 @@ "type": "integer" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the disk volume belongs to", + "description": "path of the Domain the account's domain belongs to", "name": "domainpath", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the ID of the event", + "name": "id", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the type of the resource", + "name": "resourcetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the account's domain", + "name": "domain", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - {}, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "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": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the resource", + "name": "resourcename", "type": "string" } - ], - "since": "4.18.0.0" + ] }, { - "description": "Deletes a userdata", - "isasync": false, - "name": "deleteUserData", + "description": "Creates resource tag(s)", + "isasync": true, + "name": "createTags", "params": [ { - "description": "an optional project for the userdata", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "customer", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "list of resources to create the tags for", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the ID of the Userdata", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "id", - "related": "", + "name": "tags", "required": true, - "type": "uuid" + "type": "map" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "type of the resource", "length": 255, - "name": "account", - "required": false, + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], - "since": "4.18" + "since": "4.0.0" }, { - "description": "Get SolidFire Account ID", - "isasync": false, - "name": "getSolidFireAccountId", + "description": "Create an Internal Load Balancer element.", + "isasync": true, + "name": "createInternalLoadBalancerElement", "params": [ { - "description": "CloudStack Account UUID", - "length": 255, - "name": "accountid", - "required": true, - "type": "string" - }, - { - "description": "Storage Pool UUID", + "description": "the network service provider ID of the internal load balancer element", "length": 255, - "name": "storageid", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ {}, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -53487,112 +53017,68 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Lists role permissions", + "description": "Reset api count", "isasync": false, - "name": "listRolePermissions", + "name": "resetApiLimit", "params": [ { - "description": "ID of the role", + "description": "the ID of the account whose limit to be reset", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "account", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } ], - "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", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, {}, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", - "type": "string" - }, - { - "description": "the ID of the role permission", - "name": "id", - "type": "string" - }, - { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.9.0" + ] }, { - "description": "Lists all network services provided by CloudStack or for the given Provider.", + "description": "Deletes a VLAN IP range.", "isasync": false, - "name": "listSupportedNetworkServices", + "name": "deleteVlanIpRange", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, - "type": "string" - }, - { - "description": "network service provider name", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "the id of the VLAN IP range", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" } ], - "related": "", "response": [ {}, { @@ -53602,108 +53088,77 @@ }, {}, { - "description": "the service name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the 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 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": "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": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { - "description": "Deletes a particular ingress rule from this security group", + "description": "Generates an alert", "isasync": true, - "name": "revokeSecurityGroupIngress", + "name": "generateAlert", "params": [ { - "description": "The ID of the ingress rule", + "description": "Name of the alert", "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Zone id for which alert is generated", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "Alert description", + "length": 999, + "name": "description", "required": true, + "type": "string" + }, + { + "description": "Pod id for which alert is generated", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" + }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -53711,233 +53166,183 @@ "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.3" }, { - "description": "Lists dedicated guest vlan ranges", + "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", "isasync": false, - "name": "listDedicatedGuestVlanRanges", + "name": "ldapConfig", "params": [ { - "description": "project who will own the guest VLAN range", + "description": "Enter the password.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "bindpass", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "pagesize", + "name": "port", "required": false, "type": "integer" }, { - "description": "", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "page", + "name": "binddn", "required": false, - "type": "integer" + "type": "string" }, { - "description": "zone of the guest VLAN range", + "description": "If true return current LDAP configuration", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the dedicated guest vlan range", + "description": "Enter the password for trust store.", "length": 255, - "name": "guestvlanrange", + "name": "truststorepass", "required": false, "type": "string" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "account", + "name": "searchbase", "required": false, "type": "string" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "queryfilter", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "keyword", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "physical network id of the guest VLAN range", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "truststore", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "ldapRemove", "response": [ { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "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 domain ID of the guest VLAN range", - "name": "domainid", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the project name of the guest vlan range", - "name": "project", - "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", + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, + {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, - { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" - } - ] + {} + ], + "since": "3.0.0" }, { - "description": "Adds a network serviceProvider to a physical network", - "isasync": true, - "name": "addNetworkServiceProvider", + "description": "List vSphere storage policies", + "isasync": false, + "name": "listVsphereStoragePolicies", "params": [ { - "description": "the destination Physical Network ID to bridge to", - "length": 255, - "name": "destinationphysicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "the name for the physical network service provider", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the list of services to be enabled for this physical network service provider", + "description": "ID of the zone", "length": 255, - "name": "servicelist", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "list" - }, - { - "description": "the Physical Network ID to add the provider to", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, "type": "uuid" } ], - "related": "listNetworkServiceProviders,listTrafficTypes", + "related": "", "response": [ + {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, - {}, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -53945,238 +53350,223 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists all network ACL items", - "isasync": false, - "name": "listNetworkACLs", + "description": "Deletes a port forwarding rule", + "isasync": true, + "name": "deletePortForwardingRule", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list network ACL items by network ID", + "description": "the ID of the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "id", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "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, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list network ACL items by action", - "length": 255, - "name": "action", - "required": false, + "description": "any text associated with the success or failure", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ] + }, + { + "description": "moves a vpc to another physical network", + "isasync": true, + "name": "migrateVPC", + "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "fordisplay", + "name": "resume", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list network ACL items by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "list network ACL items by protocol", + "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": "protocol", + "name": "tiernetworkofferings", "required": false, - "type": "string" + "type": "map" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "vpc offering ID", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", - "required": false, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, "type": "uuid" }, { - "description": "", + "description": "the ID of the vpc", "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "list network ACL items by ACL ID", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "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 BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the network domain of the VPC", + "name": "networkdomain", "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": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the 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": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", "type": "integer" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -54185,8 +53575,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -54195,513 +53585,511 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Delete site to site vpn gateway", - "isasync": true, - "name": "deleteVpnGateway", - "params": [ - { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "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": "Creates a service offering.", - "isasync": false, - "name": "createServiceOffering", - "params": [ - { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", - "required": false, - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "max iops of the compute offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.4", - "type": "long" - }, + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the 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" + }, + { + "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" + } + ], + "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 name of the service offering", - "length": 255, - "name": "name", - "required": true, + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "The maximum memory size of the custom service offering in MB", - "length": 255, - "name": "maxmemory", - "required": false, - "since": "4.13", - "type": "integer" + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", - "length": 255, - "name": "storagepolicy", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "the name of the VPC", + "name": "name", + "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", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the Root disk size in GB.", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.15", - "type": "long" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { - "description": "the total memory of the service offering in MB", - "length": 255, - "name": "memory", - "required": false, - "type": "integer" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the id of the VPC", + "name": "id", "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": "the second IPv4 DNS for the VPC", + "name": "dns2", + "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 cidr the VPC", + "name": "cidr", + "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, - "since": "4.4", - "type": "integer" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "whether compute offering iops is custom or not", + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes a global load balancer rule.", + "isasync": true, + "name": "deleteGlobalLoadBalancerRule", + "params": [ + { + "description": "the ID of the global load balancer rule", "length": 255, - "name": "customizediops", - "required": false, - "since": "4.4", + "name": "id", + "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": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the HA for the service offering", - "length": 255, - "name": "offerha", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "update an annotation visibility.", + "isasync": false, + "name": "updateAnnotationVisibility", + "params": [ { - "description": "the ID of the disk offering to which service offering should be mapped", + "description": "the annotation is visible for admins only", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "since": "4.17", - "type": "uuid" + "name": "adminsonly", + "required": true, + "type": "boolean" }, { - "description": "the host tag for this service offering.", + "description": "the id of the annotation", "length": 255, - "name": "hosttags", - "required": false, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "addAnnotation,listAnnotations,removeAnnotation", + "response": [ + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "min iops of the compute offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, + {}, { - "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", - "length": 255, - "name": "cpuspeed", - "required": false, - "type": "integer" + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "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 (uu)id of the annotation", + "name": "id", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "is this a system vm offering", - "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "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 username of the user that entered the annotation", + "name": "username", + "type": "string" }, { - "description": "the CPU number of the service offering", - "length": 255, - "name": "cpunumber", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Whether service offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "since": "4.13", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, + {} + ], + "since": "4.16" + }, + { + "description": "Configures HA for a host", + "isasync": true, + "name": "configureHAForHost", + "params": [ { - "description": "burst io requests write rate of the disk offering", + "description": "ID of the host", "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "HA provider", "length": 255, - "name": "displaytext", - "required": false, + "name": "provider", + "required": true, "type": "string" - }, + } + ], + "related": "enableHAForHost,disableHAForHost", + "response": [ + {}, + {}, { - "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", + "description": "if host HA is enabled for the host", + "name": "haenable", "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "details for planner, used to store specific parameters", - "length": 255, - "name": "serviceofferingdetails", - "required": false, - "type": "map" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" + "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 HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the tags for this service offering.", - "length": 255, - "name": "tags", - "required": false, + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "the ID of the host", + "name": "hostid", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Updates a configuration.", + "isasync": false, + "name": "updateConfiguration", + "params": [ + { + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "limitcpuuse", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "dynamicscalingenabled", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.16", - "type": "boolean" + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "byteswriteratemax", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "long" + "type": "uuid" }, { - "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", + "description": "the value of the configuration", + "length": 4096, + "name": "value", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "minmemory", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "since": "4.13", - "type": "integer" + "type": "uuid" }, { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "isvolatile", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "VMs using this offering require root volume encryption", + "description": "the name of the configuration", "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "cachemode", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "since": "4.14", - "type": "string" + "type": "uuid" } ], - "related": "updateServiceOffering,listServiceOfferings", + "related": "listConfigurations", "response": [ { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the description of the configuration", + "name": "description", + "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 value of the configuration", + "name": "value", + "type": "string" }, + {}, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "true if the configuration is dynamic", + "name": "isdynamic", "type": "boolean" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the component of the configuration", + "name": "component", "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 display text of the configuration", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the name of the configuration", + "name": "name", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" }, - {}, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { @@ -54710,336 +54098,424 @@ "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the group of the configuration", + "name": "group", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + } + ] + }, + { + "description": "Lists volume stats", + "isasync": false, + "name": "listVolumesUsageHistory", + "params": [ + { + "description": "the ID of the volume.", + "length": 255, + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "type": "uuid" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "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" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "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": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, + "description": "the IDs of the volumes, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, + {}, { - "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": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the ID of the volume", + "name": "id", + "type": "string" }, { - "description": "the name of the service offering", + "description": "the name of the volume", "name": "name", "type": "string" }, + {}, { - "description": "the memory in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ], + "since": "4.18.0" + }, + { + "description": "Dedicates a Public IP range to an account", + "isasync": false, + "name": "dedicatePublicIpRange", + "params": [ + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "state of the service offering", - "name": "state", + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the id of the VLAN IP range", + "length": 255, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" + } + ], + "related": "createVlanIpRange,updateVlanIpRange", + "response": [ + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the 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 host tag for the service offering", - "name": "hosttags", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, + {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the domain ID of the VLAN IP range", "name": "domainid", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the description of the VLAN IP range", + "name": "description", "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 network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, - {}, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the project name of the vlan range", + "name": "project", + "type": "string" } ] }, { - "description": "Copies a template from one zone to another.", - "isasync": true, - "name": "copyTemplate", + "description": "Adds API permissions to a project role", + "isasync": false, + "name": "createProjectRolePermission", "params": [ { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the project role", "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, "type": "uuid" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "The rule permission, allow or deny. Default: deny.", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "permission", + "required": true, + "type": "string" + }, + { + "description": "The description of the role permission", + "length": 255, + "name": "description", "required": false, - "type": "list" + "type": "string" }, { - "description": "Template ID.", + "description": "The API name or wildcard rule such as list*", "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": "rule", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "listProjectRolePermissions", "response": [ { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the project", + "name": "projectid", "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 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 ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Deletes an empty Bucket.", + "isasync": false, + "name": "deleteBucket", + "params": [ { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "createBucket,listBuckets", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -55047,321 +54523,354 @@ "name": "jobstatus", "type": "integer" }, + {}, + {} + ], + "since": "4.19.0" + }, + { + "description": "Create a console endpoint to connect to a VM console", + "isasync": false, + "name": "createConsoleEndpoint", + "params": [ { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "(optional) extra security token, valid when the extra validation is enabled", + "length": 255, + "name": "token", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the console url", + "name": "url", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, + "description": "details in case of an error", + "name": "details", + "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Updates a project role permission and/or order", + "isasync": false, + "name": "updateProjectRolePermission", + "params": [ { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" }, { - "description": "the template ID", - "name": "id", + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Project Role permission rule id", + "length": 255, + "name": "projectrolepermissionid", + "related": "listProjectRolePermissions", + "required": false, + "type": "uuid" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "ID of project where project role permission is to be updated", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "length": 255, + "name": "ruleorder", + "related": "listProjectRolePermissions", + "required": false, + "type": "list" + } + ], + "response": [ { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 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" + } + ], + "since": "4.15.0" + }, + { + "description": "Adds user to a project", + "isasync": true, + "name": "addUserToProject", + "params": [ + { + "description": "ID of the project to add the user to", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "Name of the user to be added to the project", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "Project role type to be assigned to the user - Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "email ID of user to which invitation to the project is going to be sent", + "length": 255, + "name": "email", + "required": false, "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - {}, + } + ], + "response": [ { - "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 name of the zone for this template", - "name": "zonename", + "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", - "name": "isdynamicallyscalable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.14" + }, + { + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, + "type": "string" + } + ], + "response": [ { - "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": "the ID of the secondary storage host for the template", - "name": "hostid", + "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": "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": "lists network that are using a nicira nvp device", + "description": "Recovers a virtual machine.", "isasync": false, - "name": "listNiciraNvpDeviceNetworks", + "name": "recoverVirtualMachine", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "nicira nvp device ID", + "description": "The ID of the virtual machine", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - }, + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "response": [ + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "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" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + }, { - "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the domain 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": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -55369,6 +54878,11 @@ "name": "project", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", @@ -55380,8 +54894,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -55390,841 +54909,1359 @@ "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": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "type": "set" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the details of the network", + "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, - {}, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "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": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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": "the network's gateway", - "name": "gateway", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the 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" - } - ], + "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 service name", + "description": "the name of the affinity group", "name": "name", "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], - "type": "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": "zone id of the network", - "name": "zoneid", - "type": "string" + "type": "set" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "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 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": "security group name", + "name": "securitygroupname", + "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": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "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": "related to what other network configuration", - "name": "related", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "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 domain name of the network owner", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "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 name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + {}, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" } ] }, { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "description": "Resets network permissions.", "isasync": false, - "name": "assignVirtualMachine", + "name": "resetNetworkPermissions", "params": [ { - "description": "an optional project for the new VM owner.", + "description": "the network ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "domain id of the new VM owner.", + "description": "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.17.0" + }, + { + "description": "Updates an existing Bgp Peer.", + "isasync": true, + "name": "updateBgpPeer", + "params": [ + { + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "ip6address", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "ipaddress", "required": false, - "type": "list" + "type": "string" }, { - "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": "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": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "cleanupdetails", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "id of the VM to be moved", + "description": "Id of the Bgp Peer", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": true, "type": "uuid" }, { - "description": "account name of the new VM owner.", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "account", + "name": "asnumber", + "required": false, + "type": "long" + }, + { + "description": "The password of the Bgp Peer.", + "length": 255, + "name": "password", "required": false, "type": "string" + }, + { + "description": "BGP peer details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "date when this bgp peer was created.", + "name": "created", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "id of the bgp peer", + "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 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": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "update Tungsten-Fabric loadbalancer health monitor", + "isasync": true, + "name": "updateTungstenFabricLBHealthMonitor", + "params": [ + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "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": "loadbalancer health monitor url path", + "length": 255, + "name": "urlpath", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "loadbalancer health monitor interval", + "length": 255, + "name": "interval", + "required": true, "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", + "required": false, + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "loadbalancer health monitor retry", + "length": 255, + "name": "retry", + "required": true, + "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the 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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "loadbalancer health monitor timeout", + "length": 255, + "name": "timeout", + "required": true, + "type": "integer" }, { - "description": "User VM type", - "name": "vmtype", + "description": "loadbalancer health monitor type", + "length": 255, + "name": "type", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "the health monitor expected code", + "name": "expectedcode", "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 health monitor interval", + "name": "interval", + "type": "int" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the health monitor type", + "name": "type", "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" }, + {}, { - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 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 LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the health monitor ID", + "name": "id", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "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", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -56232,1425 +56269,872 @@ "type": "integer" }, { - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Accepts or declines project invitation", + "isasync": true, + "name": "updateProjectInvitation", + "params": [ + { + "description": "if true, accept the invitation, decline if false. True by default", + "length": 255, + "name": "accept", + "required": false, "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "list invitations for specified account; this parameter has to be specified with domainId", + "length": 255, + "name": "token", + "required": false, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" + "description": "id of the project to join", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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 vGPU type used by the virtual machine", - "name": "vgpu", + "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 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": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", "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": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the domain ID of the snapshot's account", "name": "domainid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" - }, + } + ] + }, + { + "description": "Updates a condition for VM auto scaling", + "isasync": true, + "name": "updateCondition", + "params": [ { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the condition.", + "length": 255, + "name": "id", + "related": "listConditions", + "required": true, + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + {}, + { + "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": "any text associated with the success or failure", + "name": "displaytext", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.18.0" + }, + { + "description": "Lists Regions", + "isasync": false, + "name": "listRegions", + "params": [ + { + "description": "List Region by region name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "List Region by region ID.", + "length": 255, + "name": "id", + "required": false, + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addRegion,updateRegion", + "response": [ + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, + { + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + {}, {}, { - "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": "Attempts Migration of a system virtual machine to the host specified.", + "isasync": true, + "name": "migrateSystemVm", + "params": [ + { + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.16.0", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.16.0", + "type": "uuid" + }, + { + "description": "destination Host ID to migrate VM to", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "the Pod ID for the system VM", + "name": "podid", "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists virtual machines on a unmanaged host", - "isasync": false, - "name": "listVmsForImport", - "params": [ + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" - } - ], - "related": "listUnmanagedInstances", - "response": [ + }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, - {}, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "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 netmask of the nic", - "name": "netmask", - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "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": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "type": "set" + "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", + "description": "public vlan range", + "name": "publicvlan", + "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 name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "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 date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "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": "datastorename", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - } - ], - "type": "set" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, - {}, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": " delete a BigSwitch BCF Controller device", - "isasync": true, - "name": "deleteBigSwitchBcfDevice", + "description": "List the counters for VM auto scaling", + "isasync": false, + "name": "listCounters", "params": [ { - "description": "BigSwitch device ID", + "description": "Name of the counter.", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "name": "name", + "required": false, "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": "Source of the counter.", + "length": 255, + "name": "source", + "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": "configures a netscaler load balancer device", - "isasync": true, - "name": "configureNetscalerLoadBalancer", - "params": [ - { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "description": "List by keyword", "length": 255, - "name": "lbdevicecapacity", + "name": "keyword", "required": false, - "type": "long" + "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": "ID of the Counter.", "length": 255, - "name": "inline", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "Network provider of the counter.", "length": 255, - "name": "lbdevicededicated", + "name": "provider", "required": false, - "type": "boolean" + "since": "4.18.0", + "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.", + "description": "", "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "Netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "related": "createCounter", "response": [ + {}, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "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": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - {}, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "Source of the counter.", + "name": "source", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the id of the Counter", + "name": "id", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Name of the counter.", + "name": "name", + "type": "string" } ] }, { - "description": "Lists all available ovs elements.", - "isasync": false, - "name": "listOvsElements", + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", "params": [ { - "description": "list ovs elements by network service provider id", + "description": "the ID of the internal lb provider", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", - "required": false, + "name": "id", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list network offerings by enabled state", + "description": "Enables/Disables the Internal Load Balancer element", "length": 255, "name": "enabled", - "required": false, + "required": true, "type": "boolean" - }, - { - "description": "list ovs elements by id", - "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], - "related": "configureOvsElement", + "related": "listInternalLoadBalancerElements", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", + "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, - { - "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 domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - {}, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, { @@ -57658,238 +57142,247 @@ "name": "jobid", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "associate a profile to a blade", + "description": "remove Tungsten-Fabric tag", "isasync": true, - "name": "associateUcsProfileToBlade", + "name": "removeTungstenFabricTag", "params": [ { - "description": "ucs manager id", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" }, { - "description": "blade id", + "description": "the uuid of vms", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "vmuuid", + "required": false, + "type": "list" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" }, { - "description": "profile dn", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "profiledn", + "name": "taguuid", "required": true, "type": "string" + }, + { + "description": "the uuid of nics", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "list" } ], - "related": "", + "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "ucs blade dn", - "name": "bladedn", - "type": "string" - }, - { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "ucs blade id", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + } ] }, { - "description": "Adds a object storage pool", + "description": "Lists all available virtual router elements.", "isasync": false, - "name": "addObjectStoragePool", + "name": "listVirtualRouterElements", "params": [ { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "list virtual router elements by id", + "length": 255, + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", + "required": false, + "type": "uuid" }, { - "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 virtual router elements by network service provider id", "length": 255, - "name": "details", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the tags for the storage pool", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the object store provider name", + "description": "", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name for the object store", + "description": "list network offerings by enabled state", "length": 255, - "name": "name", - "required": true, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" } ], - "related": "", + "related": "configureVirtualRouterElement", "response": [ { - "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 object store", - "name": "name", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, - {}, { - "description": "the ID of the object store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, { - "description": "the url of the object store", - "name": "url", + "description": "the domain associated with the provider", + "name": "domain", "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 total size of the object store", - "name": "storagetotal", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes user from the project", - "isasync": true, - "name": "deleteUserFromProject", - "params": [ - { - "description": "Id of the user to be removed from the project", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID associated with the provider", + "name": "domainid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the address", + "name": "project", "type": "string" } - ], - "since": "4.15.0" + ] }, { - "description": "Checks the 2FA code for the user.", - "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", + "description": "Deletes an existing IPv4 subnet for guest network.", + "isasync": true, + "name": "deleteIpv4SubnetForGuestNetwork", "params": [ { - "description": "two factor authentication code", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "codefor2fa", + "name": "id", + "related": "createIpv4SubnetForGuestNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -57900,443 +57393,229 @@ "name": "success", "type": "boolean" }, + {}, { "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 ID of the router", - "length": 255, - "name": "routerid", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - }, - { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", - "length": 255, - "name": "performfreshchecks", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the router", - "name": "routerid", - "type": "string" - }, - { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } ], - "since": "4.14.0" + "since": "4.20.0" }, { - "description": "list control center", - "isasync": false, - "name": "listNetscalerControlCenter", + "description": "Creates a routing firewall rule in the given network in ROUTED mode", + "isasync": true, + "name": "createRoutingFirewallRule", "params": [ { - "description": "", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "The network of the VM the firewall rule will be created for", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "pagesize", + "name": "cidrlist", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "id", - "name": "id", - "type": "string" + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, "type": "integer" }, { - "description": "username", - "name": "username", - "type": "string" - }, - { - "description": "num_retries", - "name": "numretries", - "type": "string" - }, - {}, - { - "description": "ncc_ip", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Resizes a volume", - "isasync": true, - "name": "resizeVolume", - "params": [ - { - "description": "New maximum number of IOPS", + "description": "the ending port of firewall rule", "length": 255, - "name": "maxiops", + "name": "endport", "required": false, - "type": "long" + "type": "integer" }, { - "description": "New volume size in GB", + "description": "the starting port of firewall rule", "length": 255, - "name": "size", + "name": "startport", "required": false, - "type": "long" + "type": "integer" }, { - "description": "New minimum number of IOPS", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "miniops", + "name": "fordisplay", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "new disk offering id", + "description": "error code for this ICMP message", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "icmpcode", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the disk volume", + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", - "required": true, - "type": "uuid" + "name": "traffictype", + "required": false, + "type": "string" }, { - "description": "Verify OK to Shrink", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "shrinkok", + "name": "destcidrlist", "required": false, - "type": "boolean" + "type": "list" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "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 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 vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, - {}, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - {}, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -58345,209 +57624,146 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "set" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, + "type": "list" + } + ], + "since": "4.20.0" + }, + { + "description": "link a cloudstack account to a group or OU in ldap", + "isasync": false, + "name": "linkAccountToLdap", + "params": [ { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "The id of the domain that is to contain the linked account.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "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" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the account, it will be created if it does not exist", + "length": 255, + "name": "account", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, + {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" } - ] + ], + "since": "4.11.0" }, { - "description": "Deletes affinity group", + "description": "Disables out-of-band management for a host", "isasync": true, - "name": "deleteAffinityGroup", + "name": "disableOutOfBandManagementForHost", "params": [ { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", - "length": 255, - "name": "name", - "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 ID of the affinity group. Mutually exclusive with name parameter", + "description": "the ID of the host", "length": 255, - "name": "id", - "related": "", - "required": false, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, "type": "uuid" - }, - { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { "description": "the UUID of the latest async job acting on this object", @@ -58555,326 +57771,351 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, - {} - ] - }, - { - "description": "Deletes a network offering.", - "isasync": false, - "name": "deleteNetworkOffering", - "params": [ { - "description": "the ID of the network offering", - "length": 255, - "name": "id", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" } ], - "since": "3.0.0" + "since": "4.9.0" }, { - "description": "Deletes a Network Service Provider.", + "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", "isasync": true, - "name": "deleteNetworkServiceProvider", + "name": "cancelHostAsDegraded", "params": [ { - "description": "the ID of the network service provider", + "description": "host ID", "length": 255, "name": "id", - "related": "listNetworkServiceProviders,listTrafficTypes", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": true, "type": "uuid" } ], + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the name of the host", + "name": "name", "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "List network devices", - "isasync": false, - "name": "listNetworkDevice", - "params": [ { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, + "description": "Host details in key/value pairs.", + "name": "details", "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addNetworkDevice", - "response": [ - { - "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 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 ID of the network device", - "name": "id", - "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": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": false, - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum 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 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": "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" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "UUID of storage network ip range", - "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", - "response": [ + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, - {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", - "params": [ + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, { - "description": "the ID of the Pod", - "length": 255, + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the Pod ID of the host", "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "events available for the host", + "name": "events", + "type": "string" }, + {}, { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" - } - ], - "related": "listDedicatedPods", - "response": [ + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, - {}, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -58882,520 +58123,527 @@ "type": "string" }, { - "description": "the Name of the Pod", + "description": "the Pod name of the host", "name": "podname", "type": "string" }, - {}, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "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 IP address of the host", + "name": "ipaddress", "type": "string" - } - ] - }, - { - "description": "Lists Project roles in CloudStack", - "isasync": false, - "name": "listProjectRoles", - "params": [ + }, { - "description": "List project role by project role ID.", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "List project role by project role name.", - "length": 255, - "name": "name", - "required": false, + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "List project role by project ID.", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createProjectRole,updateProjectRole", - "response": [ - {}, + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, { - "description": "the name of the role", - "name": "name", + "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" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "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 amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, - {} + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + } ], - "since": "4.15.0" + "since": "4.16.0.0" }, { - "description": "Removes an OpenDyalight controler", - "isasync": true, - "name": "deleteOpenDaylightController", + "description": "Releases an AS Number back to the pool", + "isasync": false, + "name": "releaseASNumber", "params": [ { - "description": "OpenDaylight Controller ID", + "description": "the AS Number to be released", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController", + "name": "asnumber", + "required": true, + "type": "long" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" } ], - "related": "addOpenDaylightController", "response": [ { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the username to authenticate to the controller", - "name": "username", - "type": "string" - }, - { - "description": "the name assigned to the controller", - "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" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the url of the controller api", - "name": "url", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, {} - ] + ], + "since": "4.20.0" }, { - "description": "Updates attributes of a template.", + "description": "Creates a security group", "isasync": false, - "name": "updateTemplate", + "name": "createSecurityGroup", "params": [ { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "since": "4.20.0", - "type": "string" - }, - { - "description": "sort key of the template, integer", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "sortkey", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "name of the security group", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the format for the image", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "format", + "name": "account", "required": false, "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "Create security group for project", "length": 255, - "name": "sshkeyenabled", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the image file", + "description": "the description of the security group", "length": 255, - "name": "name", + "name": "description", "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).", - "length": 255, - "name": "templatetype", - "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": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "the 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 image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "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" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "updateSecurityGroup", "response": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the 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": "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 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 ID of the secondary storage host for the template", - "name": "hostid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, + {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "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": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the account name to which the template belongs", + "description": "the account owning the security group", "name": "account", "type": "string" }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the 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 template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the security group", + "name": "name", "type": "string" }, - { - "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 tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the project id of the template", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -59404,8 +58652,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -59414,8 +58662,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -59424,347 +58672,304 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the project name of the group", + "name": "project", "type": "string" } ] }, { - "description": "Creates a VLAN IP range.", + "description": "List network visibility and all accounts that have permissions to view this network.", "isasync": false, - "name": "createVlanIpRange", + "name": "listNetworkPermissions", "params": [ { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "Lists network permission by network ID", "length": 255, - "name": "ip6gateway", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "the account the network is available for", + "name": "account", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the project the network is available for", + "name": "project", + "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, + "description": "the ID of project the network is available for", + "name": "projectid", "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 ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "the network ID", + "name": "networkid", "type": "string" }, { - "description": "domain ID of the account owning a VLAN", - "length": 255, + "description": "the ID of the domain to which the network belongs", "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" + "description": "the ID of account the network is available for", + "name": "accountid", + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Lists site 2 site vpn gateways", + "isasync": false, + "name": "listVpnGateways", + "params": [ { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "List by keyword", "length": 255, - "name": "ip6cidr", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the physical network id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "the network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "true if the IP range is used for NSX resource", + "description": "", "length": 255, - "name": "fornsx", + "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, - "since": "4.20.0", "type": "boolean" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "", "length": 255, - "name": "startip", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "updatePod,createManagementNetworkIpRange", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "forsystemvms", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "id of the vpn gateway", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", "required": false, "type": "uuid" }, { - "description": "the netmask of the VLAN IP range", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "netmask", + "name": "account", "required": false, "type": "string" }, { - "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": "id of vpc", "length": 255, - "name": "vlan", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the owner", + "name": "account", "type": "string" }, + {} + ] + }, + { + "description": "Moves a user to another account in the same domain.", + "isasync": false, + "name": "moveUser", + "params": [ { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "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 project id of the vlan range", - "name": "projectid", + "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "id of the user to be moved.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, {}, @@ -59772,30 +58977,40 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" - }, + } + ], + "since": "4.11" + }, + { + "description": "Releases host reservation.", + "isasync": true, + "name": "releaseHostReservation", + "params": [ { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" - }, + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59806,10 +59021,18 @@ ] }, { - "description": "Updates site to site vpn connection", + "description": "Create site to site vpn connection", "isasync": true, - "name": "updateVpnConnection", + "name": "createVpnConnection", "params": [ + { + "description": "id of the vpn gateway", + "length": 255, + "name": "s2svpngatewayid", + "related": "createVpnGateway,updateVpnGateway", + "required": true, + "type": "uuid" + }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -59819,38 +59042,37 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "connection is passive or not", "length": 255, - "name": "customid", + "name": "passive", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "id of vpn connection", + "description": "id of the customer gateway", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "required": true, "type": "uuid" } ], - "related": "createVpnConnection,listVpnConnections", + "related": "updateVpnConnection", "response": [ { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the connection ID", - "name": "id", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", @@ -59858,23 +59080,28 @@ "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "State of vpn connection", + "name": "state", + "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { @@ -59883,60 +59110,58 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, - {}, - {}, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { @@ -59945,56 +59170,44 @@ "type": "integer" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, + {}, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "lists network that are using Palo Alto firewall device", + "description": "lists network that are using a brocade vcs switch", "isasync": false, - "name": "listPaloAltoFirewallNetworks", + "name": "listBrocadeVcsDeviceNetworks", "params": [ - { - "description": "palo alto balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -60002,6 +59215,14 @@ "required": false, "type": "integer" }, + { + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -60017,21 +59238,61 @@ "type": "integer" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { @@ -60039,208 +59300,142 @@ "name": "associatednetworkid", "type": "string" }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "The external id of the network", - "name": "externalid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "name": "ip4routes", "type": "set" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "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 ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "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" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { "description": "display text of the network offering the network is created from", @@ -60248,95 +59443,74 @@ "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "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": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { "description": "the name of the network", "name": "name", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { "description": "the project id of the ipaddress", @@ -60344,324 +59518,298 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, - {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, + {}, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the owner of the network", - "name": "account", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "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": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "state of the network", - "name": "state", + "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": "VPC the network belongs to", - "name": "vpcid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "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": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "The 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 network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, + {}, { "description": "the date this network was created", "name": "created", "type": "date" - } - ] - }, - { - "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, + "description": "the project name of the address", + "name": "project", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 id of the network", + "name": "id", + "type": "string" }, { - "description": "The path field for the volume", - "name": "path", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" } ] }, { - "description": "Purge expunged resources", - "isasync": true, - "name": "purgeExpungedResources", + "description": "Lists Webhook deliveries", + "isasync": false, + "name": "listWebhookDeliveries", "params": [ { - "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "description": "The event type of the Webhook delivery", "length": 255, - "name": "startdate", + "name": "eventtype", "required": false, - "type": "date" + "type": "string" }, { - "description": "The size of batch used during purging", + "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": "batchsize", + "name": "startdate", "required": false, - "type": "long" + "type": "date" }, { - "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "description": "The 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 type of the resource which need to be purged. Supported types: VirtualMachine", + "description": "", "length": 255, - "name": "resourcetype", + "name": "pagesize", "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", - "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" - }, - { - "description": "Lists management servers.", - "isasync": false, - "name": "listManagementServers", - "params": [ - { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { - "description": "the id of the management server", + "description": "The ID of the Webhook", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, "type": "uuid" }, @@ -60680,763 +59828,942 @@ "type": "string" }, { - "description": "", + "description": "The ID of the management server", "length": 255, - "name": "pagesize", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "createWebhook", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "The ID of the Webhook", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, + {}, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the name of the management server", - "name": "name", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" + }, + { + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, {}, { - "description": "the ID of the management server", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" + }, + { + "description": "The description of the Webhook", + "name": "description", + "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Updates a vm group", - "isasync": false, - "name": "updateInstanceGroup", + "description": "Dedicates a host.", + "isasync": true, + "name": "dedicateHost", "params": [ { - "description": "Instance group ID", + "description": "the ID of the containing domain", "length": 255, - "name": "id", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, { - "description": "new instance group name", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" + }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" } ], - "related": "createInstanceGroup", + "related": "listDedicatedHosts", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the name of the instance group", - "name": "name", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "the account owning the instance group", - "name": "account", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "description": "Adds the GloboDNS external host", "isasync": true, - "name": "changeOfferingForVolume", + "name": "addGloboDnsHost", "params": [ { - "description": "the ID of the volume", + "description": "Username for GloboDNS", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "name": "username", "required": true, - "type": "uuid" - }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "type": "string" }, { - "description": "new disk offering id", + "description": "the Physical Network ID", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, "type": "uuid" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "type": "boolean" - }, - { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, - { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "description": "GloboDNS url", "length": 255, - "name": "automigrate", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { - "description": "New volume size in GB for the custom disk offering", + "description": "Password for GloboDNS", "length": 255, - "name": "size", - "required": false, - "type": "long" + "name": "password", + "required": true, + "type": "string" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.5.0" + }, + { + "description": "Logs out the user", + "isasync": false, + "name": "logout", + "params": [], + "related": "", + "response": [ + {}, { - "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": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "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": "Response description", + "name": "description", "type": "string" }, + {} + ] + }, + { + "description": "Imports a role based on provided map of rule permissions", + "isasync": false, + "name": "importRole", + "params": [ { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "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": "ID of the disk volume", - "name": "id", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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": "pod name of the volume", - "name": "podname", + "description": "Creates a role with this unique name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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" + } + ], + "related": "createRole,listRoles,updateRole", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the role", + "name": "name", "type": "string" }, {}, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "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": "name of the disk volume", - "name": "name", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the description of the role", + "name": "description", "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "since": "4.15.0" + }, + { + "description": "Updates existing email templates for quota alerts", + "isasync": false, + "name": "quotaEmailTemplateUpdate", + "params": [ + { + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", + "required": true, "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "The locale of the email text", + "length": 255, + "name": "locale", + "required": false, "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "length": 255, + "name": "templatetype", + "required": true, "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "The quota email template subject, max: 77 characters", + "length": 77, + "name": "templatesubject", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ], + "since": "4.7.0" + }, + { + "description": "Restart a Shared FileSystem", + "isasync": true, + "name": "restartSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is cleanup required", + "length": 255, + "name": "cleanup", + "required": false, "type": "boolean" - }, + } + ], + "response": [ { - "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": "name of the service offering for root disk", - "name": "serviceofferingname", - "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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists network serviceproviders for a given physical network.", + "isasync": false, + "name": "listNetworkServiceProviders", + "params": [ { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "list providers by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "list providers by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + } + ], + "related": "addNetworkServiceProvider,listTrafficTypes", + "response": [ { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "uuid of the network provider", + "name": "id", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "state of the network provider", + "name": "state", "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": "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, + {}, { - "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" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "delete Tungsten-Fabric tag type", + "isasync": true, + "name": "deleteTungstenFabricTagType", + "params": [ { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the current status 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 format of the disk encryption if applicable", - "name": "encryptformat", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes an Object Storage Pool", + "isasync": false, + "name": "deleteObjectStoragePool", + "params": [ + { + "description": "The Object Storage ID.", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "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 status of the volume", - "name": "status", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Delete Netscaler Control Center", + "isasync": false, + "name": "deleteNetscalerControlCenter", + "params": [ { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Netscaler Control Center ID", + "length": 255, + "name": "id", + "related": "", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "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": "Deletes a detached disk volume.", + "isasync": false, + "name": "deleteVolume", + "params": [ + { + "description": "The ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "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 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": "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": "id of the virtual machine", - "name": "virtualmachineid", + "description": "The unique identifier of the secondary storage selector.", + "length": 255, + "name": "id", + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "required": true, + "type": "uuid" + } + ], + "related": "listSecondaryStorageSelectors", + "response": [ + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" } ], - "since": "4.17" + "since": "4.19.0" }, { - "description": "List the uploaded certificates for direct download templates", + "description": "Enables a user account", "isasync": false, - "name": "listTemplateDirectDownloadCertificates", + "name": "enableUser", "params": [ { - "description": "the zone where certificates are uploaded", + "description": "Enables user by user ID.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, "type": "uuid" - }, + } + ], + "related": "createUser,disableUser,getUser,listUsers,lockUser", + "response": [ + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "list direct download certificate by ID", - "length": 255, + "description": "the user ID", "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", - "length": 255, - "name": "listhosts", - "required": false, + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + {}, + { + "description": "the account type of the user", + "name": "accounttype", "type": "integer" - } - ], - "related": "uploadTemplateDirectDownloadCertificate", - "response": [ + }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "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 zone name where the certificate is uploaded", - "name": "zonename", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, - {}, { - "description": "the direct download certificate issuer", - "name": "issuer", + "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 direct download certificate alias", - "name": "alias", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -61444,465 +60771,402 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "List ucs manager", + "description": "Creates a quota tariff for a resource.", "isasync": false, - "name": "listUcsManagers", + "name": "quotaTariffCreate", "params": [ { - "description": "", + "description": "Integer value for the usage type of the resource.", "length": 255, - "name": "pagesize", - "required": false, + "name": "usagetype", + "required": true, "type": "integer" }, { - "description": "the ID of the ucs manager", - "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", + "length": 65535, + "name": "activationrule", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "keyword", + "name": "enddate", "required": false, + "type": "date" + }, + { + "description": "Quota tariff's name", + "length": 65535, + "name": "name", + "required": true, "type": "string" }, { - "description": "", + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "The quota tariff value of the resource as per the default unit.", "length": 255, - "name": "page", + "name": "value", + "required": true, + "type": "double" + }, + { + "description": "Position in the execution sequence for tariffs of the same type", + "length": 255, + "name": "position", "required": false, + "since": "4.20.0.0", "type": "integer" }, { - "description": "the zone id", + "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current date. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" } ], - "related": "addUcsManager", + "related": "quotaTariffList", "response": [ + {}, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of ucs manager", + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "usageUnit", + "name": "usageUnit", + "type": "string" + }, + { + "description": "name", "name": "name", "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "description", + "name": "description", "type": "string" }, - {}, { - "description": "the url of ucs manager", - "name": "url", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + }, + { + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageName", + "name": "usageName", + "type": "string" + }, + { + "description": "the ID of the tariff", + "name": "id", + "type": "string" + }, + { + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", + "type": "string" + }, + { + "description": "currency", + "name": "currency", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.18.0.0" }, { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", + "description": "Suspends a project", + "isasync": true, + "name": "suspendProject", "params": [ { - "description": "The ID of the router", + "description": "id of the project to be suspended", "length": 255, "name": "id", - "related": "destroyRouter,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", + "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" } ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", + "related": "activateProject,createProject", "response": [ { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "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 guest IP address for the router", - "name": "guestipaddress", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the 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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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" - } - ], - "type": "set" - }, - { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, - {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, - {}, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -61911,228 +61175,326 @@ "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], + "related": "", + "response": [ + { + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" }, + {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the account name of the api remaining count", + "name": "account", "type": "string" }, { - "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 public IP address for the router", - "name": "publicip", + "description": "the account uuid of the api remaining count", + "name": "accountid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" }, + {} + ] + }, + { + "description": "Deletes a storage network IP Range.", + "isasync": true, + "name": "deleteStorageNetworkIpRange", + "params": [ { - "description": "the template ID for the router", - "name": "templateid", + "description": "the uuid of the storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "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 associated with the router", - "name": "domainid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Remove an Ldap Configuration", + "description": "Adds a VMware datacenter to specified zone", "isasync": false, - "name": "deleteLdapConfiguration", + "name": "addVmwareDc", "params": [ { - "description": "port", + "description": "The password for specified username.", "length": 255, - "name": "port", + "name": "password", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Hostname", + "description": "The Zone ID.", "length": 255, - "name": "hostname", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "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": "linked domain", + "description": "Name of VMware datacenter to be added to specified zone.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "addLdapConfiguration", + "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": "name of the host running the ldap server", - "name": "hostname", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "linked domain", - "name": "domainid", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" - } - ], - "since": "4.2.0" + }, + {}, + { + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] }, { - "description": "Updates the volume.", + "description": "Updates Ipv6 firewall rule with specified ID", "isasync": true, - "name": "updateVolume", + "name": "updateIpv6FirewallRule", "params": [ { - "description": "The path of the volume", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "path", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Destination storage pool UUID for the volume", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "startport", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "description": "The chain info of the volume", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "chaininfo", + "name": "traffictype", "required": false, - "since": "4.4", "type": "string" }, { - "description": "the ID of the disk volume", + "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "name": "fordisplay", "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the ipv6 firewall rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, "type": "uuid" }, { - "description": "new name of the volume", + "description": "type of the ICMP message being sent", "length": 255, - "name": "name", + "name": "icmptype", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -62143,1311 +61505,1336 @@ "type": "string" }, { - "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "deleteprotection", + "name": "cidrlist", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "list" }, { - "description": "The state of the volume", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "state", + "name": "protocol", "required": false, - "since": "4.3", "type": "string" - }, - { - "description": "an optional field, whether to the display the volume to the end user or not.", - "length": 255, - "name": "displayvolume", - "required": false, - "type": "boolean" } ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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 list of resource tags associated", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "type": "list" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "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": "name of the disk volume", - "name": "name", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the state of the rule", + "name": "state", "type": "string" + } + ] + }, + { + "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,createProject", + "required": false, + "type": "list" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, "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 template ID", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "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" + } + ], + "response": [ + { + "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 volume to the end user or not.", - "name": "displayvolume", + "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 bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "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 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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACL", + "params": [ + { + "description": "the ID of the network ACL", + "length": 255, + "name": "id", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "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": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "List Autonomous Systems Number Ranges", + "isasync": false, + "name": "listASNRanges", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Created date", + "name": "created", + "type": "date" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the AS Number Range", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "End AS Number", + "name": "endasn", + "type": "long" + }, + {}, + { + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "Start AS Number", + "name": "startasn", "type": "long" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", + "params": [ { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Tungsten-Fabric tag type", + "length": 255, + "name": "tagtype", + "required": true, "type": "string" - }, + } + ], + "related": "listTungstenFabricTag,applyTungstenFabricTag", + "response": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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": "min iops of the disk volume", - "name": "miniops", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "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": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - }, + } + ] + }, + { + "description": "Adds an OpenDyalight controler", + "isasync": true, + "name": "addOpenDaylightController", + "params": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Api URL of the OpenDaylight Controller.", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Username to access the OpenDaylight API", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Credential to access the OpenDaylight API", + "length": 255, + "name": "password", + "required": true, "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, + } + ], + "related": "deleteOpenDaylightController", + "response": [ + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "device id of the controller", + "name": "id", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the url of the controller api", + "name": "url", "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": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" } ] }, { - "description": "Lists traffic types of a given physical network.", + "description": "Creates a Zone.", "isasync": false, - "name": "listTrafficTypes", + "name": "createZone", "params": [ { - "description": "", + "description": "the second DNS for the Zone", "length": 255, - "name": "pagesize", + "name": "dns2", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the name of the Zone", "length": 255, - "name": "keyword", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "page", + "name": "ip6dns2", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Physical Network ID", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "listNetworkServiceProviders", - "response": [ - { - "description": "the provider name", - "name": "name", + "name": "internaldns2", + "required": false, "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the ID of the containing domain, null for public zones", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if the zone is an edge zone, false otherwise", + "length": 255, + "name": "isedge", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "network type of the zone, can be Basic or Advanced", + "length": 255, + "name": "networktype", + "required": true, + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "Allocation state of this Zone for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "Network domain name for the networks in the zone", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, - {}, - {} - ], - "since": "3.0.0" - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "createProjectRole", - "params": [ { - "description": "creates a project role with this unique name", + "description": "the first DNS for the Zone", "length": 255, - "name": "name", + "name": "dns1", "required": true, "type": "string" }, { - "description": "ID of project where role is being created", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "internaldns1", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The description of the Project role", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "description", + "name": "securitygroupenabled", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "updateProjectRole", + "related": "listZones", "response": [ { - "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", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "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 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", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, - {} - ], - "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": "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 second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, + {}, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "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, + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "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": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "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, + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], "type": "list" }, { - "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" - } - ], - "related": "createRoutingFirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, + {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "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": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" } ] }, { - "description": "Updates account information for the authenticated user", + "description": "Lists all children domains belonging to a specified domain", "isasync": false, - "name": "updateAccount", + "name": "listDomainChildren", "params": [ { - "description": "The UUID of the dynamic role to set for the account", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Details for the account used to store specific parameters", + "description": "list children domains by name", "length": 255, - "name": "accountdetails", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "networkdomain", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The UUID of the domain where the account exists", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Current account name", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "New name for the account", + "description": "If set to false, list only 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": "newname", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Account UUID", + "description": "list children domain by parent domain ID.", "length": 255, "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, - {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "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": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "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 type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - } - ], - "type": "list" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "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 domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", + "description": "the total secondary storage space (in GiB) the domain can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, - {}, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, + {}, { - "description": "the total volume being used by this account", + "description": "the total volume being used by this domain", "name": "volumetotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", + "description": "the total number of cpu cores owned by domain", "name": "cputotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by account", + "description": "the total number of vpcs owned by domain", "name": "vpctotal", "type": "long" - }, + } + ] + }, + { + "description": "Returns an encrypted password for the VM", + "isasync": false, + "name": "getVMPassword", + "params": [ { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", "type": "string" }, { @@ -63455,86 +62842,184 @@ "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" }, + {} + ] + }, + { + "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", + "isasync": true, + "name": "assignToGlobalLoadBalancerRule", + "params": [ { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the list load balancer rules that will be assigned to global load balancer rule", + "length": 255, + "name": "loadbalancerrulelist", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "length": 255, + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on 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": "Adds secondary storage.", + "description": "Adds S3 Image Store", "isasync": false, - "name": "addSecondaryStorage", + "name": "addImageStoreS3", "params": [ { - "description": "the Zone ID for the secondary storage", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "connectiontimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the URL for the secondary storage", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "url", + "name": "s3signer", + "required": false, + "type": "string" + }, + { + "description": "Use HTTPS instead of HTTP", + "length": 255, + "name": "usehttps", + "required": false, + "type": "boolean" + }, + { + "description": "S3 secret key", + "length": 255, + "name": "secretkey", + "required": true, + "type": "string" + }, + { + "description": "Socket timeout (milliseconds)", + "length": 255, + "name": "sockettimeout", + "required": false, + "type": "integer" + }, + { + "description": "S3 access key", + "length": 255, + "name": "accesskey", + "required": true, + "type": "string" + }, + { + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", + "required": true, + "type": "string" + }, + { + "description": "Connection TTL (milliseconds)", + "length": 255, + "name": "connectionttl", + "required": false, + "type": "integer" + }, + { + "description": "Maximum number of times to retry on error", + "length": 255, + "name": "maxerrorretry", + "required": false, + "type": "integer" + }, + { + "description": "Whether TCP keep-alive is used", + "length": 255, + "name": "usetcpkeepalive", + "required": false, + "type": "boolean" + }, + { + "description": "Name of the storage bucket", + "length": 255, + "name": "bucket", "required": true, "type": "string" } ], - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ - {}, { "description": "the ID of the image store", "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the url of the image store", + "name": "url", "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" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the scope of the image store", @@ -63542,23 +63027,18 @@ "type": "scopetype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { @@ -63571,639 +63051,1048 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, { "description": "the protocol of the image store", "name": "protocol", "type": "string" - }, - {} - ] + } + ], + "since": "4.7.0" }, { - "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": "Upload a certificate for HTTPS direct template download on KVM hosts", "isasync": false, - "name": "updateVirtualMachine", + "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", + "description": "Hypervisor type", + "length": 255, + "name": "hypervisor", + "required": true, "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", + "description": "Name for the uploaded certificate", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "description": "Zone to upload certificate", "length": 255, - "name": "name", - "required": false, - "since": "4.4", - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "customid", + "name": "hostid", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "since": "4.4", + "type": "uuid" + }, + { + "description": "SSL certificate", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + } + ], + "related": "listTemplateDirectDownloadCertificates", + "response": [ + { + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, + {}, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" + }, + { + "description": "the direct download certificate subject", + "name": "subject", + "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": "the hosts where the certificate is uploaded to", + "name": "hostsmap", "type": "list" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the direct download certificate version", + "name": "version", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Import unmanaged virtual machine from a given cluster.", + "isasync": true, + "name": "importUnmanagedInstance", + "params": [ + { + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "userdatadetails", + "name": "nicnetworklist", "required": false, - "since": "4.18", "type": "map" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "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": "haenable", + "name": "migrateallowed", "required": false, "type": "boolean" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "an optional account for the virtual machine. Must be used with domainId.", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "group of the virtual machine", + "description": "the host name of the instance", "length": 255, - "name": "group", + "name": "hostname", "required": false, "type": "string" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "import instance to the domain specified", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "the service offering for the virtual machine", "length": 255, - "name": "displayvm", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "import instance for the project", "length": 255, - "name": "details", + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", "required": false, "type": "map" }, { - "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "deleteprotection", + "name": "datadiskofferinglist", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "map" }, { - "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": "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": "cleanupdetails", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "the ID of the userdata", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "userdataid", - "related": "", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "since": "4.18", "type": "uuid" }, { - "description": "the ID of the OS type that best represents this VM.", + "description": "the cluster ID", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, "type": "uuid" }, { - "description": "user generated name", + "description": "used to specify the custom parameters.", "length": 255, - "name": "displayname", + "name": "details", "required": false, - "type": "string" + "type": "map" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the account owning the affinity group", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the project name of the affinity group", - "name": "project", - "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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 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": "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the description of the affinity group", + "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the security group", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account owning the affinity group", + "name": "account", "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 domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the affinity group", + "name": "name", "type": "string" } ], "type": "set" }, { - "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "description": "an optional field whether to the display the vm to the end user or not.", "name": "displayvm", "type": "boolean" }, { - "description": "the 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": "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the read (IO) of disk on the VM", "name": "diskioread", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the 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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -64211,13 +64100,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -64231,18 +64115,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -64255,52 +64139,42 @@ "name": "domainpath", "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -64309,1890 +64183,2207 @@ "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the 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 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 name of the security group", - "name": "name", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "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" - } - ], - "type": "set" + "description": "the ID of the corresponding network", + "name": "networkid", + "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "true if vm 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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "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", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" - }, + } + ], + "since": "4.14.0" + }, + { + "description": "Creates a physical network", + "isasync": true, + "name": "createPhysicalNetwork", + "params": [ { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the physical network", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "length": 255, + "name": "isolationmethods", + "required": false, + "type": "list" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + } + ], + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "response": [ + { + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the uuid of the physical network", "name": "id", "type": "string" }, + {}, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "name of the physical network", + "name": "name", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the speed of the physical network", + "name": "networkspeed", "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": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the physical network", + "name": "state", "type": "string" } - ] + ], + "since": "3.0.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", + "description": "Lists autoscale vm groups.", "isasync": false, - "name": "triggerShutdown", + "name": "listAutoScaleVmGroups", "params": [ { - "description": "the uuid of the management server", + "description": "the ID of the loadbalancer", "length": 255, - "name": "managementserverid", - "related": "", - "required": true, + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, "type": "uuid" - } - ], - "related": "prepareForShutdown", - "response": [ + }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" - } - ], - "since": "4.19.0" - }, - { - "description": "Disables an account", - "isasync": true, - "name": "disableAccount", - "params": [ + }, { - "description": "Disables specified account.", + "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": "Account id", + "description": "the ID of the autoscale vm group", "length": 255, "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, "type": "uuid" }, { - "description": "Disables specified account in this domain.", + "description": "the availability zone ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "If true, only lock the account; else disable the account", + "description": "the ID of the policy", "length": 255, - "name": "lock", - "required": true, - "type": "boolean" - } - ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "name": "policyid", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, + "description": "the ID of the profile", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": false, + "type": "uuid" + } + ], + "related": "enableAutoScaleVmGroup", + "response": [ { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "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 templates which can be created by this account", - "name": "templatelimit", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, + {}, { - "description": "id of the Domain the account belongs to", + "description": "the domain ID of the vm group", "name": "domainid", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "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 date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", - "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": "Updates a Pod.", + "isasync": false, + "name": "updatePod", + "params": [ { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, - {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the netmask of the Pod", + "length": 255, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the ID of the Pod", + "length": 255, + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" - }, + } + ], + "related": "createPod,listPods,createManagementNetworkIpRange", + "response": [ { - "description": "the state of the account", - "name": "state", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of 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 primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "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 total number of cpu cores the account can own", - "name": "cpulimit", - "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 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 total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "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 total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", "type": "list" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the list of users associated with account", - "name": "user", + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user email address", - "name": "email", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the gateway for the range", + "name": "gateway", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ { - "description": "the account name of the user", - "name": "account", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user name", - "name": "username", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the name of the role", - "name": "rolename", + "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 Zone ID", + "name": "zoneid", + "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "Lists domains and provides detailed information for listed domains", - "isasync": false, - "name": "listDomains", - "params": [ + }, { - "description": "Tag for resource type to return usage", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "List domain by domain name.", - "length": 255, + "description": "the name of the Pod", "name": "name", - "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": "List domains by domain level.", - "length": 255, - "name": "level", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" - }, + } + ] + }, + { + "description": "Attaches an ISO to a virtual machine.", + "isasync": true, + "name": "attachIso", + "params": [ { - "description": "List domain by domain ID.", + "description": "the ID of the virtual machine", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, - "name": "page", + "name": "forced", "required": false, - "type": "integer" + "since": "4.15.1", + "type": "boolean" }, { - "description": "flag to display the resource icon for domains", + "description": "the ID of the ISO file", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" } ], - "related": "listDomainChildren,listDomains", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "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 public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the state of the domain", - "name": "state", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the 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 project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "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 domain", - "name": "networkdomain", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the 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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the 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 netmask of the nic", + "name": "netmask", + "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 IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Updates a network", - "isasync": true, - "name": "updateNetwork", - "params": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "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 name of the host for the virtual machine", + "name": "hostname", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the new name for the network", - "length": 255, - "name": "name", - "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": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "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", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the new display text for the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "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": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the ID of the virtual machine", + "name": "id", "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": "zone id of the network", - "name": "zoneid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "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": "list networks that are persistent", - "name": "ispersistent", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "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 network domain", - "name": "networkdomain", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, + {} + ] + }, + { + "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "isasync": false, + "name": "ldapRemove", + "params": [], + "related": "", + "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, + {}, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", + "type": "string" + } + ], + "since": "3.0.1" + }, + { + "description": "Creates a user for an account that already exists", + "isasync": false, + "name": "createUser", + "params": [ { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "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 BGP peers for the network", - "name": "bgppeers", - "type": "set" + "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 network", - "name": "id", + "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 network's gateway", - "name": "gateway", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, + "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "email", + "length": 255, + "name": "email", + "required": true, + "type": "string" + } + ], + "related": "disableUser,getUser,listUsers,lockUser", + "response": [ + { + "description": "the user state", + "name": "state", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the secret key of the user", + "name": "secretkey", "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": "the details of the network", - "name": "details", - "type": "map" + "description": "the ID of the role", + "name": "roleid", + "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 user email address", + "name": "email", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -66201,202 +66392,430 @@ "type": "integer" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - {}, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the type of the role", + "name": "roletype", "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 user ID", + "name": "id", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the user name", + "name": "username", "type": "string" + } + ] + }, + { + "description": "Creates site to site vpn local gateway", + "isasync": true, + "name": "createVpnGateway", + "params": [ + { + "description": "public ip address id of the vpn gateway", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "updateVpnGateway", + "response": [ + { + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the address", + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "the project name", "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the owner of the network", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the owner", "name": "account", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the network owner", + "description": "the domain name of the owner", "name": "domain", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "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": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "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", + "type": "string" }, { - "description": "the domain id of the network owner", + "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": "Lists vpn users", + "isasync": false, + "name": "listVpnUsers", + "params": [ + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the username of the vpn user.", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "The uuid of the Vpn user", + "length": 255, + "name": "id", + "related": "addVpnUser,listVpnUsers", + "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 internet protocol of network offering", - "name": "internetprotocol", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addVpnUser", + "response": [ + {}, + { + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" } ] }, { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", + "description": "Deletes an IP forwarding rule", + "isasync": true, + "name": "deleteIpForwardingRule", + "params": [ + { + "description": "the ID of the forwarding rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + } + ], "response": [ { - "description": "Usage type description", - "name": "description", + "description": "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": "Register a new userdata.", + "isasync": false, + "name": "registerUserData", + "params": [ + { + "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": "Name of the userdata", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of variables declared in userdata content", + "length": 255, + "name": "params", + "required": false, "type": "string" }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "response": [ {}, { "description": "the current status of the latest async job acting on this object", @@ -66404,1045 +66823,920 @@ "type": "integer" }, { - "description": "Usage type ID", + "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.18" + }, + { + "description": "Adds a Region", + "isasync": false, + "name": "addRegion", + "params": [ + { + "description": "Id of the Region", + "length": 255, "name": "id", + "required": true, "type": "integer" }, { - "description": "Usage type name", + "description": "Name of the region", + "length": 255, "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Region service endpoint", + "length": 255, + "name": "endpoint", + "required": true, "type": "string" + } + ], + "related": "updateRegion", + "response": [ + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the region", + "name": "id", + "type": "integer" }, {}, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the name of the region", + "name": "name", + "type": "string" + }, + { + "description": "the end point of the region", + "name": "endpoint", + "type": "string" } ] }, { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "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": "resetUserDataForVirtualMachine", + "name": "generateUsageRecords", "params": [ { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "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": false, + "type": "date" + }, + { + "description": "List events for the specified domain.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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": "userdatadetails", + "name": "enddate", "required": false, - "type": "map" + "type": "date" + } + ], + "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": "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": "The ID of the virtual machine", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Updates a role permission order", + "isasync": false, + "name": "updateRolePermission", + "params": [ + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "account", + "name": "permission", "required": false, + "since": "4.11", "type": "string" }, { - "description": "the ID of the userdata", + "description": "ID of the role", "length": 255, - "name": "userdataid", + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", "related": "", "required": false, + "since": "4.11", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "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": "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 pool type of the virtual machine", - "name": "pooltype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists accounts and provides detailed account information for listed accounts", + "isasync": false, + "name": "listAccounts", + "params": [ + { + "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "flag to display the resource icon for accounts", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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": "ssh key-pairs", - "name": "keypairs", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "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": "list account by account ID", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "list accounts by cleanuprequired attribute (values are true or false)", + "length": 255, + "name": "iscleanuprequired", + "required": false, + "type": "boolean" + }, + { + "description": "list account by account name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account owning the affinity group", + "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 account name of the user", "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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 secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the 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 user ID", "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the user state", + "name": "state", "type": "string" } ], - "type": "set" + "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + {}, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, { - "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": "the date when this virtual machine was created", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + {}, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the date when this account was created", "name": "created", "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "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 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "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", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - {}, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" - }, + } + ] + }, + { + "description": "Destroys a router.", + "isasync": true, + "name": "destroyRouter", + "params": [ { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "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": "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", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "tag value", - "name": "value", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "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" } ], - "type": "set" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - {}, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the 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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "type": "list" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "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 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": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the list of nics associated with vm", + "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { "description": "the gateway of the nic", "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -67456,28 +67750,28 @@ "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 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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -67486,19 +67780,19 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -67506,2113 +67800,1930 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "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", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "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": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" }, { - "description": "Necessary if the template's type is system.", - "length": 255, - "name": "issystem", - "required": false, - "since": "4.20.0", - "type": "boolean" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the ID of the template", - "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": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" - } - ], - "response": [ + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", - "params": [ + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "list network ACLs by VPC ID", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "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 link local IP address for the router", + "name": "linklocalip", + "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 state of the router", + "name": "state", + "type": "state" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the hostname for the router", + "name": "hostname", "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 domain associated with the router", + "name": "domain", + "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 VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" + "description": "the first DNS for the router", + "name": "dns1", + "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 entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, + "description": "the version of template", + "name": "version", "type": "string" }, + {}, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "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 id of the router", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createNetworkACLList", - "response": [ + "description": "the project name of the address", + "name": "project", + "type": "string" + }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + } + ] }, { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", - "isasync": true, - "name": "archiveSnapshot", + "description": "Lists image stores.", + "isasync": false, + "name": "listImageStores", "params": [ { - "description": "The ID of the snapshot", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the image store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "the image store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "the ID of the storage pool", "length": 255, "name": "id", - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": true, + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the image store", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" + }, + { + "description": "read-only status of the image store", + "length": 255, + "name": "readonly", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "since": "4.15.0", + "type": "boolean" } ], - "related": "copySnapshot,revertSnapshot,listSnapshots", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "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 project id of the snapshot", - "name": "projectid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the 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 provider name of the image store", + "name": "providername", + "type": "string" }, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + } + ], + "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": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Disables out-of-band management for a cluster", + "isasync": true, + "name": "disableOutOfBandManagementForCluster", + "params": [ + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, + {}, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the operation result", + "name": "status", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Activates a project", + "isasync": true, + "name": "activateProject", + "params": [ + { + "description": "id of the project to be modified", + "length": 255, + "name": "id", + "related": "activateProject,createProject", + "required": true, + "type": "uuid" + } + ], + "related": "createProject", + "response": [ + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the list of resource tags associated", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, {}, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", - "params": [ + "description": "the total volume available for this project", + "name": "volumeavailable", + "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": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" }, { "description": "the 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, 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 domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" - } - ], - "related": "createVpnGateway,listVpnGateways", - "response": [ - { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "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": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "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 project", + "name": "templatetotal", + "type": "long" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, - {} + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + } ], - "since": "4.4" + "since": "3.0.0" }, { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", + "description": "Delete a certificate to CloudStack", + "isasync": false, + "name": "deleteSslCert", "params": [ { - "description": "the ID of the dedicated guest vlan range", + "description": "Id of SSL certificate", "length": 255, "name": "id", - "related": "", + "related": "uploadSslCert", "required": true, "type": "uuid" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Deletes security group", + "description": "Delete one or more alerts.", "isasync": false, - "name": "deleteSecurityGroup", + "name": "deleteAlerts", "params": [ { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the project of the security group", + "description": "delete by alert type", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "the IDs of the alerts", "length": 255, - "name": "account", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "string" + "type": "list" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "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": "id", - "related": "createSecurityGroup", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "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": "name", + "name": "enddate", "required": false, - "type": "string" + "type": "date" } ], "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, {} ] }, { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", + "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", "isasync": true, - "name": "migrateVirtualMachine", + "name": "createAutoScaleVmProfile", "params": [ { - "description": "the ID of the virtual machine", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" + }, + { + "description": "the time allowed for existing connections to get closed before a vm is expunged", + "length": 255, + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" + }, + { + "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", + "type": "boolean" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", "required": false, + "since": "4.18.1", "type": "uuid" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "autoselect", + "name": "counterparam", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "map" + }, + { + "description": "an optional project for the autoscale VM profile", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" + }, + { + "description": "the service offering of the auto deployed virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "availability zone for the auto deployed virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "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": "account that will own the autoscale VM profile", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the project id vm profile", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + {}, + { + "description": "the autoscale vm profile ID", "name": "id", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project name of the vm profile", + "name": "project", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + {}, + { + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" + } + ] + }, + { + "description": "Register the OAuth2 provider in CloudStack", + "isasync": false, + "name": "registerOauthProvider", + "params": [ + { + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": true, + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": true, "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", + "required": true, + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of 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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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 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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the 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 project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists load balancer stickiness policies.", + "isasync": false, + "name": "listLBStickinessPolicies", + "params": [ + { + "description": "the ID of the load balancer stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "response": [ + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the domain associated with the tag", - "name": "domain", - "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", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the Stickiness policy", + "name": "description", "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 state of the policy", + "name": "state", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" - }, - {}, + } + ], + "since": "3.0.0" + }, + { + "description": "Adds a Ucs manager", + "isasync": false, + "name": "addUcsManager", + "params": [ { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the password of UCS", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the Zone id for the ucs manager", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of UCS url", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the username of UCS", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, + "description": "the name of UCS manager", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "listUcsManagers", + "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "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": "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": "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 corresponding network", - "name": "networkid", - "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 virtual machine", - "name": "name", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteVnfTemplate", + "params": [ + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "Necessary if the template's type is system.", + "length": 255, + "name": "issystem", + "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "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" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "lists netscaler load balancer devices", + "isasync": false, + "name": "listNetscalerLoadBalancers", + "params": [ { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": false, + "type": "uuid" + } + ], + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "response": [ + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "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 format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "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 device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Creates a vm group", + "isasync": false, + "name": "createInstanceGroup", + "params": [ { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the instance group", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "The project of the instance group", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID of account owning the instance group", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "updateInstanceGroup", + "response": [ + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + {}, + { + "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 domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the project name of the instance group", + "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 domain name of the instance group", + "name": "domain", "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account owning the instance group", + "name": "account", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, + {} + ] + }, + { + "description": "Creates an internal load balancer", + "isasync": true, + "name": "createLoadBalancer", + "params": [ { - "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the 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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the 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 source port the network traffic will be load balanced from", + "length": 255, + "name": "sourceport", + "required": true, + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "The guest network the load balancer will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the load balancer", + "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": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - } - ] - }, - { - "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", - "isasync": true, - "name": "importVolume", - "params": [ - { - "description": "the ID of the disk offering linked to the volume", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "name": "scheme", + "required": true, + "type": "string" }, { - "description": "the ID of the storage pool", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "algorithm", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional account for the volume. Must be used with domainId.", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "instanceport", + "required": true, + "type": "integer" }, { - "description": "import volume to the domain specified", + "description": "the network id of the source ip address", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, "type": "uuid" }, { - "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "description": "the source IP address the network traffic will be load balanced from", "length": 255, - "name": "name", + "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "import volume for the project", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", "required": false, - "type": "uuid" - }, - { - "description": "the path of the volume", - "length": 255, - "name": "path", - "required": true, - "type": "string" + "since": "4.4", + "type": "boolean" } ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "", "response": [ { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "size of the disk volume", - "name": "size", - "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": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { - "description": "ID of the disk volume", + "description": "the Load Balancer ID", "name": "id", "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": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "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": "cluster id of the volume", - "name": "clusterid", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { @@ -69621,87 +69732,52 @@ "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -69710,388 +69786,390 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the instance", + "name": "name", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, + {}, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Adds a Palo Alto firewall device", + "isasync": true, + "name": "addPaloAltoFirewall", + "params": [ { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "URL of the Palo Alto appliance.", + "length": 255, + "name": "url", + "required": true, "type": "string" - }, + } + ], + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the zone ID of the external firewall", + "name": "zoneid", + "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 account associated with the disk volume", - "name": "account", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "device state", + "name": "fwdevicestate", "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 read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "device capacity", + "name": "fwdevicecapacity", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the public security zone of the external firewall", + "name": "publiczone", "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", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "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.", + "description": "Creates a private gateway", "isasync": true, - "name": "createTemplate", + "name": "createPrivateGateway", "params": [ { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "the gateway of the Private gateway", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "isfeatured", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "uuid" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "length": 255, + "name": "bypassvlanoverlapcheck", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "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": "sshkeyenabled", + "name": "sourcenatsupported", "required": false, "type": "boolean" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the tag for this template.", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "templatetag", - "required": false, + "name": "ipaddress", + "required": true, "type": "string" }, { - "description": "the name of the template", + "description": "the netmask of the Private gateway", "length": 255, - "name": "name", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,revertSnapshot,listSnapshots", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "create template for the project", + "description": "the VPC network belongs to", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "requireshvm", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" + } + ], + "related": "createPrivateGateway,listPrivateGateways", + "response": [ + { + "description": "the project name of the private gateway", + "name": "project", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the private gateway's netmask", + "name": "netmask", + "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": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "the zone for the template. Can be specified with snapshot only", - "length": 255, + "description": "zone id of the private gateway", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "string" }, { - "description": "32 or 64 bit", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "description": "VPC id the private gateway belongs to", + "name": "vpcid", + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "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 id of the private gateway", + "name": "id", + "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 associated with the private gateway", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "since": "4.19.0", - "type": "uuid" - } - ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + "type": "string" + }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, + {}, { - "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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -70099,509 +70177,472 @@ "type": "integer" }, { - "description": "the project name of the template", - "name": "project", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the project id of the template", - "name": "projectid", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the gateway", + "name": "gateway", "type": "string" }, - {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "Deletes a firewall rule", + "isasync": true, + "name": "deleteFirewallRule", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the 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": "Upload a certificate to CloudStack", + "isasync": false, + "name": "uploadSslCert", + "params": [ { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional project for the SSL certificate", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Password for the private key", + "length": 255, + "name": "password", + "required": false, + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "Enables revocation checking for certificates", + "length": 255, + "name": "enabledrevocationcheck", + "required": false, + "since": "4.15", "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "name", + "name": "name", "type": "string" }, {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" - }, + } + ] + }, + { + "description": "Updates the registered OAuth provider details", + "isasync": false, + "name": "updateOauthProvider", + "params": [ { - "description": "the status of the template", - "name": "status", + "description": "Client ID pre-registered in the specific OAuth provider", + "length": 255, + "name": "clientid", + "required": false, "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": false, "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "OAuth provider will be enabled or disabled based on this value", + "length": 255, + "name": "enabled", + "required": false, "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "id of the OAuth provider to be updated", + "length": 255, + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" }, + {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "Name of the provider", + "name": "name", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" - } - ] - }, - { - "description": "list baremetal rack configuration", - "isasync": false, - "name": "listBaremetalRct", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "addBaremetalRct", - "response": [ - { - "description": "url", - "name": "url", - "type": "string" }, - {}, { - "description": "id of rct", - "name": "id", + "description": "Name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the provider", + "name": "id", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", + "description": "Creates site to site vpn customer gateway", "isasync": true, - "name": "uploadCustomCertificate", + "name": "createVpnCustomerGateway", "params": [ { - "description": "A name / alias for the certificate.", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "name", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "since": "4.6", + "type": "uuid" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "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", + "description": "name of this customer gateway", "length": 255, - "name": "id", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "domainsuffix", + "name": "cidrlist", "required": true, "type": "string" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", "required": true, "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": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "type": "string" - } - ] - }, - { - "description": "Lists dedicated clusters.", - "isasync": false, - "name": "listDedicatedClusters", - "params": [ + }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "account", + "name": "forceencap", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "pagesize", + "name": "dpd", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ID of the domain associated with the cluster", + "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": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "keyword", + "name": "ikelifetime", "required": false, - "type": "string" + "type": "long" }, { - "description": "the ID of the cluster", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "splitconnections", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "boolean" }, { - "description": "", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "page", + "name": "ikepolicy", + "required": true, + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", "required": false, - "type": "integer" + "since": "4.15.1", + "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "updateVpnCustomerGateway", "response": [ { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -70609,43 +70650,66 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the domain ID of the cluster", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the domain id of the owner", "name": "domainid", "type": "string" }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, {}, - {} - ] - }, - { - "description": "Lists available certificate authority providers in CloudStack", - "isasync": false, - "name": "listCAProviders", - "params": [ { - "description": "List CA service provider by name", - "length": 255, + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "name of the customer gateway", "name": "name", - "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the description of the CA service provider", - "name": "description", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -70653,587 +70717,825 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the CA service provider name", - "name": "name", + "description": "the project name", + "name": "project", "type": "string" }, - {} - ], - "since": "4.11.0" + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + } + ] }, { - "description": "Delete site to site vpn customer gateway", - "isasync": true, - "name": "deleteVpnCustomerGateway", + "description": "remove an annotation.", + "isasync": false, + "name": "removeAnnotation", "params": [ { - "description": "id of customer gateway", + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "addAnnotation,listAnnotations", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, - {} - ] + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" + }, + { + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + {}, + { + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "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", + "type": "string" + } + ], + "since": "4.11" }, { - "description": "Lists all port forwarding rules for an IP address.", + "description": "add a baremetal host", "isasync": false, - "name": "listPortForwardingRules", + "name": "addBaremetalHost", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list of tags to be added to the host", "length": 255, - "name": "fordisplay", + "name": "hosttags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "list port forwarding rules for certain network", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddress", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "the cluster name for the host", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "clustername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "hypervisor type of the host", "length": 255, - "name": "account", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "", + "description": "the cluster ID for the host", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the Pod ID for the host", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "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 host URL", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "url", + "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": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "listall", + "name": "username", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "password", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists rule with the specified ID.", + "description": "the Zone ID for the host", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "List by keyword", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" } ], - "related": "createRoutingFirewallRule,updateIpv6FirewallRule,updatePortForwardingRule", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "the 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 state of the rule", - "name": "state", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "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 public ip address id for the port forwarding rule", - "name": "ipaddressid", - "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 list of resource tags associated with the rule", - "name": "tags", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "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 displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ID of the host", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Allocates IP addresses in respective Pod of a Zone", - "isasync": false, - "name": "acquirePodIpAddress", - "params": [ + }, { - "description": "Pod ID", - "length": 255, - "name": "podid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Gateway for Pod ", - "name": "gateway", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "CIDR of the Pod", - "name": "cidr", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "Allocated IP address", + "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "description": "MAC address of the pod the IP", - "name": "hostmac", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" - } - ] - }, - { - "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 password", - "name": "password", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the out-of-band management interface username", - "name": "username", - "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 out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", - "isasync": false, - "name": "updateTemplatePermissions", - "params": [ + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "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": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the template ID", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + {}, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + } + ] + }, + { + "description": "Disables a role", + "isasync": false, + "name": "disableRole", + "params": [ + { + "description": "ID of the role", "length": 255, "name": "id", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createRole,listRoles,updateRole", "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "any text associated with the success or failure", + "name": "displaytext", + "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" + }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Deletes a role permission", + "isasync": false, + "name": "deleteRolePermission", + "params": [ + { + "description": "ID of the role permission", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, {} - ] + ], + "since": "4.9.0" }, { - "description": "List traffic monitor Hosts.", + "description": "Update VM Schedule.", "isasync": false, - "name": "listTrafficMonitors", + "name": "updateVMSchedule", "params": [ { - "description": "zone Id", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "schedule", + "required": false, + "type": "string" + }, + { + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "Enable VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "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": "Name of the schedule", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "updateVMSchedule", "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all configuration groups (primarily used for UI).", + "isasync": false, + "name": "listConfigurationGroups", + "params": [ + { + "description": "lists configuration group by group name", + "length": 255, + "name": "group", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -71245,234 +71547,295 @@ "type": "string" } ], - "related": "addTrafficMonitor", + "related": "", "response": [ { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" }, - {}, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" + }, + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "the name of the configuration group", + "name": "name", "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Releases a Pod IP back to the Pod", + "isasync": false, + "name": "releasePodIpAddress", + "params": [ + { + "description": "UUID of the Pod IP", + "length": 255, + "name": "id", + "required": true, + "type": "long" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "any text associated 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": "Releases an existing dedicated Bgp Peer.", + "description": "Updates remote access vpn", "isasync": true, - "name": "releaseBgpPeer", + "name": "updateRemoteAccessVpn", "params": [ { - "description": "Id of the Bgp Peer", + "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 the remote access vpn", "length": 255, "name": "id", - "related": "updateBgpPeer,releaseBgpPeer", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", "required": true, "type": "uuid" } ], - "related": "updateBgpPeer", + "related": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the account of the bgp peer", - "name": "account", + "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": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "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" }, {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "the domain ID of the bgp peer", + "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.20.0" + "since": "4.4" }, { - "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]", + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", "isasync": true, - "name": "resetPasswordForVirtualMachine", + "name": "destroyVirtualMachine", "params": [ + { + "description": "Comma separated list of UUIDs for volumes that will be deleted", + "length": 255, + "name": "volumeids", + "related": "importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "since": "4.12.0", + "type": "list" + }, { "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, - "name": "password", + "name": "expunge", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.2.1", + "type": "boolean" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "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 type of the template for the virtual machine", - "name": "templatetype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -71481,14 +71844,14 @@ "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { "description": "the ip address of the nic", @@ -71496,13 +71859,8 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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" }, { @@ -71511,78 +71869,78 @@ "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -71591,42 +71949,47 @@ "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "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 name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "the 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 userdata used for the VM", + "name": "userdataname", "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 virtual machine", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "OS name of the vm", @@ -71634,109 +71997,333 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, {}, { - "description": "the 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 Service from LB rule", + "name": "servicestate", "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the 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": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "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" }, { @@ -71744,13 +72331,18 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -71758,19 +72350,24 @@ "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": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -71778,99 +72375,194 @@ "name": "value", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 ID of the security group", - "name": "domainid", - "type": "string" - }, + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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 description of the security group", + "name": "description", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -71884,8 +72576,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -71894,23 +72591,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -71922,69 +72609,69 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -71993,8 +72680,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -72003,8 +72690,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -72018,54 +72710,64 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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": "security group name", "name": "securitygroupname", "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" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -72073,269 +72775,565 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + } + ] + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "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": "the ID of the host for the virtual machine", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, "name": "hostid", - "type": "string" + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "since": "3.0.1", + "type": "uuid" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", + "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 project name of the affinity group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the security group", + "name": "id", "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the target memory in VM (KiB)", @@ -72343,711 +73341,974 @@ "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "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", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - } - ] - }, - { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", - "isasync": true, - "name": "updatePortForwardingRule", - "params": [ + "description": "the memory allocated for the virtual machine", + "name": "memory", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the private end port of the port forwarding rule", - "length": 255, - "name": "privateendport", - "required": false, - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the private start port of the port forwarding rule", - "length": 255, - "name": "privateport", - "required": false, - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the virtual machine for the port forwarding rule", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "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", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule,updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" - } - ], - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", - "response": [ + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], - "type": "list" + "type": "set" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "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 protocol of the port forwarding rule", - "name": "protocol", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" - } - ] - }, - { - "description": "Lists Brocade VCS Switches", - "isasync": false, - "name": "listBrocadeVcsDevices", - "params": [ - { - "description": "Brocade VCS switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", - "required": false, - "type": "uuid" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "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 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 by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the principal switch Ip address", - "name": "hostname", - "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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 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 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": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "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": "isdefault", + "type": "boolean" + } + ], + "type": "set" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" } ] }, { - "description": "link an existing cloudstack domain to group or OU in ldap", + "description": "Lists the resource icon for the specified resource(s)", "isasync": false, - "name": "linkDomainToLdap", + "name": "listResourceIcon", "params": [ { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": false, - "type": "string" - }, - { - "description": "The id of the domain which has to be linked to LDAP.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" - }, - { - "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": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "accounttype", + "name": "resourceids", "required": true, - "type": "integer" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "type": "list" } ], - "related": "linkAccountToLdap", + "related": "", "response": [ + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", - "type": "string" - }, - { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "base64 representation of resource icon", + "name": "base64image", "type": "string" - }, - {} + } ], - "since": "4.6.0" + "since": "4.16.0.0" }, { - "description": "Acquires and associates a public IP to an account.", - "isasync": true, - "name": "associateIpAddress", + "description": "Creates a new Pod.", + "isasync": false, + "name": "createPod", "params": [ { - "description": "region ID from where portable IP is to be associated.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": false, - "type": "integer" - }, - { - "description": "the account to associate with this IP address", + "description": "the name of the Pod", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "IP Address to be associated", + "description": "the netmask for the Pod", "length": 255, - "name": "ipaddress", + "name": "netmask", "required": false, "type": "string" }, { - "description": "Deploy VM for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "the ending IP address for the Pod", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the domain to associate with this IP address", + "description": "the gateway for the Pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The network this IP address should be associated to.", + "description": "the starting IP address for the Pod", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "isportable", + "name": "allocationstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the VPC you want the IP address to be associated with", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "listPods,createManagementNetworkIpRange", "response": [ { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "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": "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 ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + } + ], + "type": "list" }, { - "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": "true if the entity/resource has annotations", @@ -73055,536 +74316,620 @@ "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, - {}, + {} + ] + }, + { + "description": "Safely removes raw records from cloud_usage table", + "isasync": false, + "name": "removeRawUsageRecords", + "params": [ { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, + "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": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "any text associated 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": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "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" - }, + } + ], + "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": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "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 virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "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": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.11.0" + }, + { + "description": "Lists VM metrics", + "isasync": false, + "name": "listVirtualMachinesMetrics", + "params": [ { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "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": "public IP address id", - "name": "id", - "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 ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "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 domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "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": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "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": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the list of resource tags associated with ip address", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "updateSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "since": "4.4", "type": "list" - } - ] - }, - { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", - "params": [ + }, { - "description": "Cluster UUID", + "description": "list vms by iso", "length": 255, - "name": "clusterid", - "required": true, - "type": "string" + "name": "isoid", + "required": false, + "type": "uuid" }, { - "description": "Storage Pool UUID", + "description": "the storage ID where vm's volumes belong to", "length": 255, "name": "storageid", - "required": true, + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "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": "Setup the 2FA for the user.", - "isasync": false, - "name": "setupUserTwoFactorAuthentication", - "params": [ + }, { - "description": "optional: the id of the user for which 2FA has to be disabled", + "description": "the host ID", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "two factor authentication code", + "description": "list by the service offering", "length": 255, - "name": "provider", + "name": "serviceofferingid", + "related": "createServiceOffering,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": "Enabled by default, provide false to disable 2FA", + "description": "list vms by template", "length": 255, - "name": "enable", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ + "type": "uuid" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", - "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 account ID of the user", - "name": "accountid", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the user name", - "name": "username", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "updateInstanceGroup", + "required": false, + "type": "uuid" }, - {}, - {} - ], - "since": "4.18.0" - }, - { - "description": "Delete site to site vpn connection", - "isasync": true, - "name": "deleteVpnConnection", - "params": [ { - "description": "id of vpn connection", + "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": "id", - "related": "createVpnConnection,listVpnConnections", - "required": true, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", + "required": false, + "since": "4.18.0", "type": "uuid" + }, + { + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "length": 255, + "name": "haenable", + "required": false, + "since": "4.15", + "type": "boolean" } ], + "related": "listVirtualMachinesMetrics", "response": [ - {}, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists all alerts types", - "isasync": false, - "name": "listAlertTypes", - "params": [], - "related": "listAlerts", - "response": [ - {}, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, { - "description": "the name of the alert", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "description of the alert", - "name": "description", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the id of the alert", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" + "description": "the date 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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" - } - ] - }, - { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", - "params": [ + }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, + "description": "disk write in MiB", + "name": "diskwrite", "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 domain in which the virtual machine exists", + "name": "domainid", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "The number of the ACL item, its ordering", - "length": 255, - "name": "number", - "required": false, - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - } - ], - "related": "updateNetworkACLItem,moveNetworkAclItem", - "response": [ + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "the ID of the ACL Item", - "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": "the list of resource tags associated with the network ACLs", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -73598,13 +74943,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -73613,179 +74958,93 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" + "type": "set" }, {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "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 state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", - "length": 255, + "description": "ssh key-pairs", "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" - }, - { - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, + "description": "the project id of the vm", "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "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": "listDomainChildren,listDomains", - "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": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { "description": "the vGPU type used by the virtual machine", @@ -73793,64 +75052,137 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -73859,243 +75191,342 @@ "type": "resourceiconresponse" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "network read in MiB", + "name": "networkread", "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name of the group", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "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" - } - ], - "type": "set" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], @@ -74106,11 +75537,41 @@ "name": "account", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -74120,8 +75581,8 @@ "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -74129,25 +75590,112 @@ "name": "domainpath", "type": "string" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, { "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -74159,32 +75707,52 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -74193,8 +75761,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -74203,8 +75771,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -74216,44 +75784,9 @@ "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" } ], "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" } ], "type": "set" @@ -74262,810 +75795,616 @@ "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the 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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "set" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - }, + } + ] + }, + { + "description": "Lists hosts.", + "isasync": false, + "name": "listHosts", + "params": [ { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the host type", + "length": 255, + "name": "type", + "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", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "length": 255, + "name": "resourcestate", + "required": false, "type": "string" }, { - "description": "the 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 state of the host", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "description": "if true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "length": 255, + "name": "outofbandmanagementpowerstate", + "required": false, "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the id of the host", + "length": 255, + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, + "description": "lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + } + ], + "related": "declareHostAsDegraded,reconnectHost", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the date when this virtual machine was created", + "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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 incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" - } - ] - }, - { - "description": "Lists site to site vpn customer gateways", - "isasync": false, - "name": "listVpnCustomerGateways", - "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 Pod ID of the host", + "name": "podid", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "id of the customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": false, - "type": "uuid" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Host details in key/value pairs.", + "name": "details", + "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 cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "createVpnCustomerGateway", - "response": [ - { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + {}, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, - {}, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" } ] }, { - "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", - "isasync": true, - "name": "deleteManagementNetworkIpRange", + "description": "Deletes a storage pool.", + "isasync": false, + "name": "deleteStoragePool", "params": [ { - "description": "The ending IP address.", + "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", "length": 255, - "name": "endip", - "required": true, - "type": "string" + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "Storage pool id", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" - }, - { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, - "type": "string" - }, - { - "description": "The vlan id the ip range sits on", - "length": 255, - "name": "vlan", - "required": true, - "type": "string" } ], "response": [ @@ -75074,13 +76413,13 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -75091,1356 +76430,980 @@ "name": "jobstatus", "type": "integer" } - ], - "since": "4.11.0.0" + ] }, { - "description": "Lists Webhooks", - "isasync": false, - "name": "listWebhooks", + "description": "Deletes an existing guest network IPv6 prefix.", + "isasync": true, + "name": "deleteGuestNetworkIpv6Prefix", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Id of the guest network IPv6 prefix", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, + "name": "id", + "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "The name of the Webhook", - "length": 255, - "name": "name", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "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 operation is executed successfully", + "name": "success", "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": "The ID of the Webhook", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.17.0.0" + }, + { + "description": "Updates a storage pool.", + "isasync": false, + "name": "updateStoragePool", + "params": [ + { + "description": "the details for the storage pool", "length": 255, - "name": "id", - "related": "createWebhook,listWebhooks,listWebhookDeliveries", + "name": "details", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "map" }, { - "description": "", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "page", + "name": "capacitybytes", "required": false, - "type": "integer" + "type": "long" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "istagarule", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "comma-separated list of tags for the storage pool", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { - "description": "The scope of the Webhook", + "description": "Change the name of the storage pool", "length": 255, - "name": "scope", + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.15", "type": "string" }, { - "description": "The state of the Webhook", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "state", + "name": "capacityiops", "required": false, - "type": "string" + "type": "long" }, { - "description": "List by keyword", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "keyword", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the Id of the storage pool", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, "type": "uuid" + }, + { + "description": "the URL of the storage pool", + "length": 255, + "name": "url", + "required": false, + "since": "4.19.0", + "type": "string" } ], - "related": "createWebhook,listWebhookDeliveries", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ + {}, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "The scope of the Webhook", - "name": "scope", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "the storage pool path", + "name": "path", "type": "string" }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Creates a global load balancer rule", - "isasync": true, - "name": "createGlobalLoadBalancerRule", - "params": [ + {}, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", - "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", - "length": 255, - "name": "gslbservicetype", - "required": true, + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "region where the global load balancer is going to be created.", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "domain name for the GSLB service.", - "length": 255, - "name": "gslbdomainname", - "required": true, + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTag", + "params": [ + { + "description": "", "length": 255, - "name": "gslblbmethod", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "account", + "name": "taguuid", "required": false, "type": "string" - } - ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", - "response": [ + }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, "type": "string" }, - {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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 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": "list" - }, - { - "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 name of the load balancer", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "applyTungstenFabricTag", + "response": [ { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "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": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" } ] }, { - "description": "Link or unlink a userdata to a template.", + "description": "Import LDAP users", "isasync": false, - "name": "linkUserDataToTemplate", + "name": "importLdapUsers", "params": [ { - "description": "the ID of the ISO for the virtual machine", + "description": "List by keyword", "length": 255, - "name": "isoid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "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": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "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": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "userdataid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "description": "", "length": 255, - "name": "userdatapolicy", + "name": "page", "required": false, - "type": "string" - } - ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + "type": "integer" + }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 OS type for this template.", - "name": "ostypename", + "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": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + } + ], + "related": "searchLdap", + "response": [ { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "The user's domain", + "name": "domain", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the template name", - "name": "name", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "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 format of the template.", - "name": "format", - "type": "imageformat" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The user's principle", + "name": "principal", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, + {} + ], + "since": "4.3.0" + }, + { + "description": "Moves a domain and its children to a new parent domain.", + "isasync": false, + "name": "moveDomain", + "params": [ { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "The ID of the domain to be moved.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the size of the template", - "name": "size", + "description": "The ID of the new parent domain of the domain to be moved.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createDomain,listDomains,listDomains", + "response": [ + { + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, - {}, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "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 total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "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 public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "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 total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "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 domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, - {} - ], - "since": "4.18.0" - }, - { - "description": " delete a netscaler load balancer device", - "isasync": true, - "name": "deleteNetscalerLoadBalancer", - "params": [ { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" - } - ], - "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 name of the domain", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" } - ] + ], + "since": "4.19.0.0" }, { - "description": "Lists load balancer rules.", + "description": "Lists all available networks.", "isasync": false, - "name": "listGlobalLoadBalancerRules", + "name": "listNetworks", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "type of the traffic", "length": 255, - "name": "tags", + "name": "traffictype", "required": false, - "type": "map" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list networks by ID", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "displaynetwork", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "region ID", + "description": "list networks by physical network id", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "pagesize", + "name": "retrieveonlyresourcecount", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "account", + "name": "type", "required": false, "type": "string" }, { - "description": "the ID of the global load balancer rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list networks by restartRequired", "length": 255, - "name": "keyword", + "name": "restartrequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the network belongs to VPC", "length": 255, - "name": "page", + "name": "forvpc", "required": false, - "type": "integer" - } - ], - "related": "updateGlobalLoadBalancerRule", - "response": [ - { - "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": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "type": "boolean" }, { - "description": "the account of the load balancer rule", + "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 load balancer", - "name": "project", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, - { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "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": "list" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "true if network is system, false otherwise", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" }, { - "description": "the domain ID of the load balancer rule", + "description": "list only resources belonging to the domain specified", + "length": 255, "name": "domainid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, - {} - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", - "params": [ { - "description": "ID of the disk offering", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "acltype", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "List resource tag(s)", - "isasync": false, - "name": "listTags", - "params": [ - { - "description": "list by value", + "description": "list networks by network offering ID", "length": 255, - "name": "value", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by resource type", + "description": "the ID or VID of the network", "length": 255, - "name": "resourcetype", + "name": "vlan", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -76450,53 +77413,53 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list by customer name", + "description": "list networks supporting certain services", "length": 255, - "name": "customer", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "list only resources belonging to the domain specified", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by key", + "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": "key", + "name": "networkfilter", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List networks by VPC", "length": 255, - "name": "account", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list networks available for VM deployment", "length": 255, - "name": "pagesize", + "name": "canusefordeploy", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" }, @@ -76508,526 +77471,502 @@ "type": "string" }, { - "description": "list by resource id", + "description": "the zone ID of the network", "length": 255, - "name": "resourceid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, + {}, { - "description": "the account associated with the tag", - "name": "account", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "since": "4.0.0" - }, - { - "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the Id of the storage pool on which change scope operation is being done", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "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": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the cluster ID for the VM", - "name": "clusterid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, - {}, { - "description": "the host ID for the VM", - "name": "hostid", + "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": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the type of VM", - "name": "type", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the cluster name for the VM", - "name": "clustername", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the hostname for the VM", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "the ID of the VM", - "name": "id", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the name of the VM", - "name": "name", + "description": "the network's gateway", + "name": "gateway", "type": "string" - } - ], - "since": "4.19.1" - }, - { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ] - }, - { - "description": "Create a virtual router element.", - "isasync": true, - "name": "createVirtualRouterElement", - "params": [ - { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", - "length": 255, - "name": "providertype", - "related": "listNetworkServiceProviders", - "required": false, - "type": "uuid" }, { - "description": "the network service provider ID of the virtual router element", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" - } - ], - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "response": [ - { - "description": "the project name of the address", - "name": "project", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, - {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The external id of the network", + "name": "externalid", "type": "string" - } - ] - }, - { - "description": "Creates a VPC", - "isasync": true, - "name": "createVPC", - "params": [ + }, { - "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "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": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, + {}, { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "create VPC for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the name of the VPC", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the VPC", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "Ids of the Bgp Peer for the VPC", - "length": 255, - "name": "bgppeerids", - "related": "updateBgpPeer", - "required": false, - "since": "4.20.0", - "type": "list" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the first IPv4 DNS for the VPC", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the AS Number of the VPC tiers", - "length": 255, - "name": "asnumber", - "required": false, - "since": "4.20.0", - "type": "long" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the 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 second IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" - } - ], - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "response": [ + }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "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 name of the owner", - "name": "domain", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - {}, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -77035,133 +77974,216 @@ "type": "resourceiconresponse" }, { - "description": "the id of the VPC", - "name": "id", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, - {}, { - "description": "the project name of the VPC", - "name": "project", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + } + ] + }, + { + "description": "Releases an IP address from the account.", + "isasync": false, + "name": "releaseIpAddress", + "params": [ + { + "description": "the ID of the public IP address to release", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "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" + } + ], + "since": "4.17" + }, + { + "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", + "isasync": true, + "name": "updatePodManagementNetworkIpRange", + "params": [ + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "The current starting IP address.", + "length": 255, + "name": "currentstartip", + "related": "listPods,createManagementNetworkIpRange", + "required": true, "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "The new starting IP address.", + "length": 255, + "name": "newstartip", + "required": false, "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "The current ending IP address.", + "length": 255, + "name": "currentendip", + "related": "listPods,createManagementNetworkIpRange", + "required": true, "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, + "description": "The new ending IP address.", + "length": 255, + "name": "newendip", + "required": false, + "type": "string" + } + ], + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the VPC", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Updates firewall rule ", + "isasync": true, + "name": "updateFirewallRule", + "params": [ { - "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, + "since": "4.4", "type": "boolean" }, { - "description": "the list of resource tags associated with the project", + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "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": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "response": [ + { + "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -77170,219 +78192,194 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the 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" - } - ], - "type": "list" - } - ], - "type": "list" - } - ] - }, - { - "description": "Deletes a autoscale policy.", - "isasync": true, - "name": "deleteAutoScalePolicy", - "params": [ + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, { - "description": "the ID of the autoscale policy", - "length": 255, + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the firewall rule", "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" + "type": "string" + }, + {}, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" } ], + "since": "4.4" + }, + { + "description": "Return true if the plugin is enabled", + "isasync": false, + "name": "quotaIsEnabled", + "params": [], + "related": "", "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "is quota service enabled", + "name": "isenabled", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] + {} + ], + "since": "4.7.0" }, { - "description": "Deletes a role", + "description": "Deletes the registered OAuth provider", "isasync": false, - "name": "deleteRole", + "name": "deleteOauthProvider", "params": [ { - "description": "ID of the role", + "description": "id of the OAuth provider to be deleted", "length": 255, "name": "id", - "related": "createRole,importRole,listRoles,updateRole", + "related": "", "required": true, "type": "uuid" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - {} + } ], - "since": "4.9.0" + "since": "4.19.0" }, { - "description": "List internal LB VMs.", + "description": "Lists all quota email templates", "isasync": false, - "name": "listInternalLoadBalancerVMs", + "name": "quotaEmailTemplateList", "params": [ { "description": "List by keyword", @@ -77392,517 +78389,366 @@ "type": "string" }, { - "description": "the state of the Internal LB VM", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "templatetype", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the host ID of the Internal LB VM", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "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 quota email template content", + "name": "templatebody", + "type": "string" }, + {}, + {}, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", - "length": 255, - "name": "fetchhealthcheckresults", - "required": false, - "since": "4.14", - "type": "boolean" + "description": "Template type", + "name": "templatetype", + "type": "string" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "The quota email template locale", + "name": "locale", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "The quota email template subject", + "name": "templatesubject", "type": "string" }, { - "description": "", + "description": "Last date/time when template was updated", + "name": "last_updated", + "type": "date" + } + ], + "since": "4.7.0" + }, + { + "description": "Creates a Bgp Peer for a zone.", + "isasync": true, + "name": "createBgpPeer", + "params": [ + { + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "UUID of the zone which the Bgp Peer belongs to.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "asnumber", + "required": true, + "type": "long" + }, + { + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Internal LB VM", + "description": "domain ID of the account owning the Bgp Peer", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "forvpc", + "name": "ip6address", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the Internal LB VM", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "name", + "name": "password", "required": false, "type": "string" } ], - "related": "destroyRouter,listRouters", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the account associated with the router", + "description": "the account of the bgp peer", "name": "account", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the Zone ID for the router", + "description": "id of zone to which the bgp peer belongs to.", "name": "zoneid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "List hypervisors", + "isasync": false, + "name": "listHypervisors", + "params": [ { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, + "description": "the zone id for listing hypervisors.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "Hypervisor name", + "name": "name", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Dedicates an existing Bgp Peer to an account or a domain.", + "isasync": true, + "name": "dedicateBgpPeer", + "params": [ { - "description": "the Pod ID for the router", - "name": "podid", + "description": "account who will own the Bgp Peer", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "project who will own the Bgp Peer", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the domain ID associated with the router", + "description": "domain ID of the account owning the Bgp Peer", + "length": 255, "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "listBgpPeers,releaseBgpPeer", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the date and time the router was created", + "description": "date when this bgp peer was created.", "name": "created", "type": "date" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "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 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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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": "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "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": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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" - } - ], - "type": "set" - }, {}, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -77911,1085 +78757,1095 @@ "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, + {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists hosts metrics", + "isasync": false, + "name": "listHostsMetrics", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "length": 255, + "name": "details", + "required": false, + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "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" - } - ], - "type": "list" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - } - ] - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", - "params": [ + "description": "lists hosts existing in particular cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { - "description": "Delete detail by resource type", + "description": "the state of the host", "length": 255, - "name": "resourcetype", - "required": true, + "name": "state", + "required": false, "type": "string" }, { - "description": "Delete details matching key/value pairs", + "description": "the id of the host", "length": 255, - "name": "key", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Delete details for resource id", + "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": "resourceid", - "required": true, + "name": "resourcestate", + "required": false, "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "length": 255, + "name": "outofbandmanagementpowerstate", + "required": false, "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "if true, list only hosts dedicated to HA", + "length": 255, + "name": "hahost", + "required": false, "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 host type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, - {} - ] - }, - { - "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": "ID of cluster", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { - "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": "the Pod ID for the host", "length": 255, - "name": "migrateto", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "map" + "type": "uuid" } ], "related": "", "response": [ { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "Id of the cluster", - "name": "clusterid", - "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", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, - {}, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, - {}, - {}, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ { - "description": "list os by description", - "length": 255, - "name": "description", - "required": false, - "since": "3.0.1", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the cluster ID of the host", + "name": "clusterid", + "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.18.1", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list by Os type Id", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "instances on the host", + "name": "instances", + "type": "string" }, { - "description": "list by Os Category id", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "addGuestOs", - "response": [ + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", + "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, - {}, { - "description": "is the guest OS user defined", - "name": "isuserdefined", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the name of the OS category", - "name": "oscategoryname", - "type": "string" - } - ] - }, - { - "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", - "type": "string" - }, - { - "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": "true if operation is executed successfully", - "name": "success", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "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": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "Uploads an icon for the specified resource(s)", - "isasync": false, - "name": "uploadResourceIcon", - "params": [ + }, { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, + "description": "the Pod ID of the host", + "name": "podid", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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 displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "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" + } + ], + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, - {}, - {} - ], - "since": "4.16.0.0" - }, - { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", - "isasync": true, - "name": "detachIso", - "params": [ { - "description": "The ID of the virtual machine", - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" - } - ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ + }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "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", - "response": [ - { - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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 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 netmask of the nic", - "name": "netmask", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "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": "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", + "type": "string" + }, + {}, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" + } + ], + "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 password (if exists) of the virtual machine", - "name": "password", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the virtual machine", + "description": "the UUID of the latest async job acting on 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 affinity groups", + "isasync": false, + "name": "listAffinityGroups", + "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "lists affinity groups by type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "lists affinity groups by name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "lists affinity groups by virtual machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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" + } + ], + "related": "createAffinityGroup", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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": "the type of the affinity group", + "name": "type", + "type": "string" }, {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" }, + {}, { - "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 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": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Register a public key in a keypair under a certain name", + "isasync": false, + "name": "registerSSHKeyPair", + "params": [ + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "User VM type", - "name": "vmtype", + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listSSHKeyPairs", + "response": [ + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, + {}, + {}, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" }, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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 name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" + } + ] + }, + { + "description": "Reserve a public IP to an account.", + "isasync": false, + "name": "reserveIpAddress", + "params": [ + { + "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the project to reserve with this IP address", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "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 account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" - }, + } + ], + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" }, + {}, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -78998,506 +79854,256 @@ "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "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 backup offering of the virtual machine", - "name": "backupofferingname", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "public IP address id", + "name": "id", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "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": "the project id of the group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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 domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the project name of the group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" } ], - "type": "set" + "type": "list" + } + ], + "since": "4.17" + }, + { + "description": "Delete one or more events.", + "isasync": false, + "name": "deleteEvents", + "params": [ + { + "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "", + "required": false, "type": "list" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - } - ] - }, - { - "description": "Deletes an existing IPv4 subnet for a zone.", - "isasync": true, - "name": "deleteIpv4SubnetForZone", - "params": [ - { - "description": "Id of the guest network IPv4 subnet", + "description": "delete by event type", "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -79507,327 +80113,343 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.20.0" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {} + ] }, { - "description": "Creates a guest network IPv6 prefix.", + "description": "Deletes an ISO file.", "isasync": true, - "name": "createGuestNetworkIpv6Prefix", + "name": "deleteIso", "params": [ { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "the ID of the ISO file", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, { - "description": "The /56 or higher IPv6 CIDR for network prefix.", + "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": "prefix", - "required": true, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], - "related": "listGuestNetworkIpv6Prefixes", "response": [ - { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, - { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } - ], - "since": "4.17.0.0" + ] }, { - "description": " delete a Palo Alto firewall device", - "isasync": true, - "name": "deletePaloAltoFirewall", + "description": "Lists VPC offerings", + "isasync": false, + "name": "listVPCOfferings", "params": [ { - "description": "Palo Alto firewall device ID", + "description": "list VPC offerings by id", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", + "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", + "description": "true if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, "type": "boolean" }, { - "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "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": "Executes a Webhook delivery", - "isasync": false, - "name": "executeWebhookDelivery", - "params": [ { - "description": "Secret key of the Webhook delivery", + "description": "list VPC offerings by state", "length": 255, - "name": "secretkey", + "name": "state", "required": false, "type": "string" }, { - "description": "The ID of the Webhook delivery for redelivery", + "description": "id of zone VPC offering is associated with", "length": 255, - "name": "id", - "related": "executeWebhookDelivery", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "Payload of the Webhook delivery", + "description": "list VPC offerings by display text", "length": 255, - "name": "payload", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "Payload URL of the Webhook delivery", + "description": "list VPC offerings by name", "length": 255, - "name": "payloadurl", + "name": "name", "required": false, "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", + "description": "", "length": 255, - "name": "sslverification", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The ID of the Webhook", + "description": "list VPC offerings supporting certain services", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "supportedservices", "required": false, - "type": "uuid" + "type": "list" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "", + "related": "updateVPCOffering", "response": [ - {}, { - "description": "The name of the Webhook", - "name": "webhookname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The ID of the event", - "name": "eventid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "The start time of the Webhook delivery", - "name": "startdate", - "type": "date" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "The ID of the Webhook", - "name": "webhookid", + "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 payload of the webhook delivery", - "name": "payload", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, + {}, { - "description": "The type of the event", - "name": "eventtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The end time of the Webhook delivery", - "name": "enddate", + "description": "the date this vpc offering was created", + "name": "created", "type": "date" }, - {}, - { - "description": "Whether Webhook delivery succeeded or not", - "name": "success", - "type": "boolean" - }, { - "description": "The ID of the Webhook delivery", + "description": "the id of the vpc offering", "name": "id", "type": "string" }, { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", + "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 headers of the webhook delivery", - "name": "headers", - "type": "string" + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": "The response of the webhook delivery", - "name": "response", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vpc offering", + "name": "name", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Deletes a Pod.", - "isasync": false, - "name": "deletePod", - "params": [ - { - "description": "the ID of the Pod", - "length": 255, - "name": "id", - "related": "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": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if vpc 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" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" } ] }, { - "description": "Lists all DeploymentPlanners available.", + "description": "Get the SF volume size including Hypervisor Snapshot Reserve", "isasync": false, - "name": "listDeploymentPlanners", + "name": "getSolidFireVolumeSize", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "Volume UUID", "length": 255, - "name": "keyword", - "required": false, + "name": "volumeid", + "required": true, "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 UUID of the latest async job acting on this object", @@ -79835,701 +80457,675 @@ "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": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" }, {} ] }, { - "description": "Creates a role", - "isasync": false, - "name": "createRole", + "description": "Uploads a data disk.", + "isasync": true, + "name": "uploadVolume", "params": [ { - "description": "The description of the role", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "description", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "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": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Upload volume for the project", "length": 255, - "name": "type", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "description": "Image store uuid", "length": 255, - "name": "ispublic", + "name": "imagestoreuuid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Creates a role with this unique name", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" - } - ], - "related": "importRole,listRoles,updateRole", - "response": [ - { - "description": "the type of the role", - "name": "type", - "type": "string" - }, - {}, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "name", - "type": "string" + "type": "uuid" }, { - "description": "the state of the role", - "name": "state", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the ID of the role", - "name": "id", + "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 description of the role", - "name": "description", - "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": "", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the volume", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "Deletes a cluster.", - "isasync": false, - "name": "deleteCluster", - "params": [ - { - "description": "the cluster ID", + "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": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "name": "checksum", + "required": false, + "type": "string" } ], + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "the account associated with the disk volume", + "name": "account", "type": "string" - } - ] - }, - { - "description": "Prepares a host for maintenance.", - "isasync": true, - "name": "prepareHostForMaintenance", - "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "response": [ + }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "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 admin that annotated this host", - "name": "username", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "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": "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": "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": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "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": "name of the disk offering", + "name": "diskofferingname", + "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": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "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": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "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 date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the name of the host", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "name of the disk volume", "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "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 after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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": "the host version", - "name": "version", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "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": "Removes specified region", + "description": "Configures a host's out-of-band management interface", "isasync": false, - "name": "removeRegion", + "name": "configureOutOfBandManagement", "params": [ { - "description": "ID of the region to delete", + "description": "the ID of the host", "length": 255, - "name": "id", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "integer" - } - ], - "response": [ + "type": "uuid" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host management interface driver, for example: ipmitool", + "length": 255, + "name": "driver", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host management interface user", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the host management interface port", + "length": 255, + "name": "port", + "required": true, + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host management interface IP address", + "length": 255, + "name": "address", + "required": true, "type": "string" - } - ] - }, - { - "description": "Get Volume's iSCSI Name", - "isasync": false, - "name": "getVolumeiScsiName", - "params": [ + }, { - "description": "CloudStack Volume UUID", + "description": "the host management interface password", "length": 255, - "name": "volumeid", + "name": "password", "required": true, "type": "string" } ], - "related": "", + "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Upload a data disk to the cloudstack cloud.", - "isasync": false, - "name": "getUploadParamsForVolume", - "params": [ + "description": "the operation result", + "name": "status", + "type": "boolean" + }, { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the 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": "the ID of the host", + "name": "hostid", + "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "Image store uuid", + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists storage tags", + "isasync": false, + "name": "listStorageTags", + "params": [ + { + "description": "", "length": 255, - "name": "imagestoreuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "List by keyword", "length": 255, - "name": "format", - "required": true, + "name": "keyword", + "required": false, "type": "string" } ], - "related": "getUploadParamsForTemplate,getUploadParamsForIso", + "related": "", "response": [ {}, { @@ -80538,18 +81134,18 @@ "type": "integer" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the name of the storage tag", + "name": "name", "type": "string" }, { @@ -80557,713 +81153,944 @@ "name": "jobid", "type": "string" }, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, {} - ], - "since": "4.6.0" + ] }, { - "description": "Updates an existing autoscale vm group.", - "isasync": true, - "name": "updateAutoScaleVmGroup", + "description": "Delete VM Schedule.", + "isasync": false, + "name": "deleteVMSchedule", "params": [ { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "ID of VM", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "virtualmachineid", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "ID of VM schedule", "length": 255, - "name": "name", + "name": "id", + "related": "", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "list of scaledown autoscale policies", + "description": "IDs of VM schedule", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "ids", + "related": "", "required": false, "type": "list" - }, + } + ], + "response": [ { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "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": "any text associated with the success or failure", + "name": "displaytext", "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.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates a IPv4 subnet for guest networks.", + "isasync": true, + "name": "createIpv4SubnetForGuestNetwork", + "params": [ + { + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", "length": 255, - "name": "maxmembers", + "name": "cidrsize", "required": false, "type": "integer" }, { - "description": "the ID of the autoscale group", + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": true, "type": "uuid" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "The CIDR of this Ipv4 subnet.", "length": 255, - "name": "interval", + "name": "subnet", "required": false, - "type": "integer" + "type": "string" } ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "related": "", "response": [ { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, {}, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "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": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, + {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the vm group", - "name": "project", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "List template visibility and all accounts that have permissions to view this template.", + "isasync": false, + "name": "listTemplatePermissions", + "params": [ { - "description": "the private port", - "name": "privateport", - "type": "string" - }, + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "response": [ { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "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 group", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, - { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" } ] }, { - "description": "Updates an existing autoscale vm profile.", - "isasync": true, - "name": "updateAutoScaleVmProfile", + "description": "Lists annotations.", + "isasync": false, + "name": "listAnnotations", "params": [ { - "description": "the ID of the userdata", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "userdataid", - "related": "", + "name": "userid", "required": false, - "since": "4.18.1", - "type": "uuid" + "since": "4.16.0", + "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "", "length": 255, - "name": "expungevmgraceperiod", + "name": "pagesize", "required": false, "type": "integer" }, { - "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": "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 template of the auto deployed virtual machine", + "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": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "annotationfilter", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "string" }, { - "description": "the ID of the autoscale vm profile", + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" - }, - { - "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", - "type": "boolean" + "type": "string" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "keyword", "required": false, - "since": "4.18.0", - "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", + "description": "the entity type", "length": 255, - "name": "customid", + "name": "entitytype", "required": false, - "since": "4.4", "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "userdatadetails", + "name": "entityid", "required": false, - "since": "4.18.1", - "type": "map" + "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "", "length": 255, - "name": "otherdeployparams", - "required": false, - "since": "4.18.0", - "type": "map" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "name": "page", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" } ], - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "related": "addAnnotation", "response": [ { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "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 domain name of the vm profile", - "name": "domain", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, + {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, + {} + ], + "since": "4.11" + }, + { + "description": "Adds Swift.", + "isasync": false, + "name": "addSwift", + "params": [ { - "description": "the account owning the instance group", + "description": "the account for swift", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the username for swift", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": " key for the user for swift", + "length": 255, + "name": "key", + "required": false, "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the URL for swift", + "length": 255, + "name": "url", + "required": true, "type": "string" - }, - {}, - {}, - {}, + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStore", + "response": [ { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, - {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "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", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, + { + "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 ID of the image store", + "name": "id", + "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Enables an AutoScale Vm Group", - "isasync": true, - "name": "enableAutoScaleVmGroup", + "description": "Lists snapshot policies.", + "isasync": false, + "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the autoscale group", + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the snapshot policy", "length": 255, "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "required": true, + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "listAutoScaleVmGroups", + "related": "updateSnapshotPolicy", "response": [ { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "maximum number of snapshots retained", + "name": "maxsnaps", "type": "int" }, + {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ] + }, + { + "description": "Update site to site vpn customer gateway", + "isasync": true, + "name": "updateVpnCustomerGateway", + "params": [ + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "Force encapsulation for Nat Traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnCustomerGateway", + "required": true, + "type": "uuid" }, { - "description": "the public ip address id", - "name": "publicipid", - "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 lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "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 domain ID of the vm group", - "name": "domainid", + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "the private port", - "name": "privateport", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" + }, + { + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "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": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", + "required": true, + "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the project id of the vm group", + "description": "the project id", "name": "projectid", "type": "string" }, { - "description": "the project name of the vm group", + "description": "the project name", "name": "project", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the autoscale vm group ", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "name of the customer gateway", "name": "name", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the account owning the vm group", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "the owner", "name": "account", "type": "string" }, + {}, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - } - ] - }, - { - "description": "Deletes a snapshot of a disk volume.", - "isasync": true, - "name": "deleteSnapshot", - "params": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "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" - } - ], - "response": [ - {}, + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" + }, + { + "description": "the 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", + "description": "apply Tungsten-Fabric tag", + "isasync": true, + "name": "applyTungstenFabricTag", "params": [ { - "description": "", + "description": "the uuid of networks", "length": 255, - "name": "page", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, + "type": "string" + }, + { + "description": "the uuid of nics", + "length": 255, + "name": "nicuuid", "required": false, - "type": "integer" + "type": "list" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "applicationpolicysetuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "UUID of the IPv6 prefix.", + "description": "the uuid of vms", "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", + "name": "vmuuid", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", + "name": "policyuuid", "required": false, "type": "string" } @@ -81272,537 +82099,662 @@ "response": [ {}, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, - {}, { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "type": "string" + "type": "long" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" } - ], - "since": "4.17.0" + ] }, { - "description": "List the virtual machines owned by the account.", + "description": "Updates object storage pool", "isasync": false, - "name": "listVirtualMachines", + "name": "updateObjectStoragePool", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the url for the object store", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list vms by vpc", + "description": "Object Store ID", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the name for the object store", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "name", "required": false, - "since": "4.4", - "type": "list" - }, + "type": "string" + } + ], + "related": "addObjectStoragePool", + "response": [ { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" + "description": "the url of the object store", + "name": "url", + "type": "string" }, { - "description": "list by the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, + "description": "the provider name of the object store", + "name": "providername", "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, - "name": "state", - "required": false, - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of AutoScaling VM Group", - "length": 255, - "name": "autoscalevmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "since": "4.18.0", - "type": "uuid" + "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,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the name of the object store", + "name": "name", + "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 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": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "Locks the specified account.", "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" + "name": "account", + "required": true, + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Locks the specified account on this domain.", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, + "description": "the id of the account", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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 total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "createInstanceGroup", - "required": false, - "type": "uuid" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" + "description": "the network domain", + "name": "networkdomain", + "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", + "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 pod ID", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "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 total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "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 total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "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": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "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 total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, + {}, { - "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 total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - } - ], - "related": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 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 ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + } + ] + }, + { + "description": "Stops a router.", + "isasync": true, + "name": "stopRouter", + "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 router", + "length": 255, + "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 corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -81811,18 +82763,18 @@ "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -81831,39 +82783,34 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "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", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "true if nic is default, false otherwise", @@ -81871,69 +82818,69 @@ "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "the gateway of the nic", @@ -81941,1601 +82888,1772 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "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 list of resource tags associated", - "name": "tags", + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "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": "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", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the project name of the vm", - "name": "project", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + } + ] + }, + { + "description": "Deletes project invitation", + "isasync": true, + "name": "deleteProjectInvitation", + "params": [ + { + "description": "id of the invitation", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "create Tungsten-Fabric firewall policy", + "isasync": true, + "name": "createTungstenFabricFirewallPolicy", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the sequence of Tungsten-Fabric firewall policy", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Tungsten-Fabric firewall policy name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + } + ] + }, + { + "description": "Updates a region", + "isasync": false, + "name": "updateRegion", + "params": [ + { + "description": "updates region with this name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "updates region with this end point", + "length": 255, + "name": "endpoint", + "required": false, "type": "string" }, + { + "description": "Id of region to update", + "length": 255, + "name": "id", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the region", + "name": "id", + "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the region", + "name": "name", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Deletes traffic type of a physical network", + "isasync": true, + "name": "deleteTrafficType", + "params": [ + { + "description": "traffic type id", + "length": 255, + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Destroy a Shared FileSystem by id", + "isasync": true, + "name": "destroySharedFileSystem", + "params": [ + { + "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 group name of the virtual machine", - "name": "group", + "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "type": "boolean" + }, + { + "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "response": [ + { + "description": "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": "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 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" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists a project's project role permissions", + "isasync": false, + "name": "listProjectRolePermissions", + "params": [ + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the project", + "name": "projectid", "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the description of the role permission", + "name": "description", "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 project role permission", + "name": "id", + "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Lists all LDAP configurations", + "isasync": false, + "name": "listLdapConfigurations", + "params": [ { - "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": "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": "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": "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": "resource type", - "name": "resourcetype", - "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "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 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 description of the security group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "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": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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": "Port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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" + } + ], + "related": "addLdapConfiguration", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, { - "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 pool type of the virtual machine", - "name": "pooltype", + "description": "linked domain", + "name": "domainid", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "description": "Creates a l2tp/ipsec remote access vpn", "isasync": true, - "name": "updateGuestOsMapping", + "name": "createRemoteAccessVpn", "params": [ { - "description": "Hypervisor specific name for this Guest OS", + "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": "osnameforhypervisor", - "required": true, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "an optional account for the VPN. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "UUID of the Guest OS to hypervisor name Mapping", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "id", - "related": "updateGuestOsMapping", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "osmappingcheckenabled", + "name": "fordisplay", "required": false, - "since": "4.19.0", + "since": "4.4", "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "length": 255, + "name": "iprange", + "required": false, "type": "string" }, - {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" - }, + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "related": "listRemoteAccessVpns", + "response": [ { - "description": "the 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": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, - {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "Lists all available disk offerings.", - "isasync": false, - "name": "listDiskOfferings", - "params": [ - { - "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", - "length": 255, - "name": "virtualmachineid", - "related": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "since": "4.20.0", - "type": "uuid" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "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 objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,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 domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "ID of the disk offering", - "length": 255, + "description": "the id of the remote access vpn", "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, + {}, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "the ipsec preshared key", + "name": "presharedkey", + "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": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "miniops", "required": false, "since": "4.17", - "type": "uuid" + "type": "long" }, { - "description": "listed offerings support disk encryption", + "description": "the service offering ID to apply to the virtual machine", "length": 255, - "name": "encrypt", - "required": false, - "since": "4.18", - "type": "boolean" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "id of zone disk offering is associated with", + "description": "The ID of the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "state", + "name": "automigrate", "required": false, - "since": "4.19", - "type": "string" + "since": "4.17", + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "listall", + "name": "maxiops", "required": false, - "type": "boolean" + "since": "4.17", + "type": "long" }, { - "description": "list only resources belonging to the domain specified", + "description": "Verify OK to Shrink", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "shrinkok", "required": false, - "type": "uuid" + "since": "4.17", + "type": "boolean" } ], - "related": "createDiskOffering", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "state of the disk offering", - "name": "state", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain 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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, {}, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "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 ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {} - ] - }, - { - "description": "Update password of a host/pool on management server.", - "isasync": false, - "name": "updateHostPassword", - "params": [ { - "description": "the username for the host/cluster", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, - "type": "uuid" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, + {}, { - "description": "if the password should also be updated on the hosts", - "length": 255, - "name": "update_passwd_on_host", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the new password for the host/cluster", - "length": 255, - "name": "password", - "required": true, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "adds a range of portable public IP's to a region", - "isasync": true, - "name": "createPortableIpRange", - "params": [ - { - "description": "the beginning IP address in the portable IP range", - "length": 255, - "name": "startip", - "required": true, - "type": "string" - }, - { - "description": "the gateway for the portable IP range", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" - }, - { - "description": "the ending IP address in the portable IP range", - "length": 255, - "name": "endip", - "required": true, - "type": "string" - }, - { - "description": "VLAN id, if not specified defaulted to untagged", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, - { - "description": "the netmask of the portable IP range", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - }, - { - "description": "Id of the Region", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "required": true, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - {}, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, - { - "description": "the end ip of the portable IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the 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 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 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": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "public IP address", - "name": "ipaddress", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes Webhook delivery", - "isasync": false, - "name": "deleteWebhookDelivery", - "params": [ + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "The ID of the management server", - "length": 255, - "name": "managementserverid", - "related": "", - "required": false, - "type": "uuid" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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 considered.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "The ID of the Webhook", - "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", - "required": false, - "type": "uuid" - } - ], - "response": [ + "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", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "addCluster", - "response": [ + }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -83543,145 +84661,259 @@ "type": "boolean" }, { - "description": "the cluster name", - "name": "name", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, + {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the capacity type", + "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": "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", - "type": "short" + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], - "type": "list" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" + "type": "set" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the project name of the vm", + "name": "project", "type": "string" } ] }, { - "description": "Lists storage providers.", + "description": "Lists all available OS mappings for given hypervisor", "isasync": false, - "name": "listStorageProviders", + "name": "listGuestOsMapping", "params": [ { "description": "List by keyword", @@ -83690,6 +84922,43 @@ "required": false, "type": "string" }, + { + "description": "list Guest OS mapping by OS mapping name with hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": false, + "type": "string" + }, + { + "description": "list mapping by its UUID", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": false, + "type": "uuid" + }, + { + "description": "list Guest OS mapping by OS display name", + "length": 255, + "name": "osdisplayname", + "required": false, + "type": "string" + }, + { + "description": "list Guest OS mapping by hypervisor", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "list mapping by Guest OS Type UUID", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -83705,56 +84974,82 @@ "type": "integer" }, { - "description": "the type of storage provider: either primary or image", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "type", - "required": true, + "name": "hypervisorversion", + "required": false, "type": "string" } ], - "related": "", + "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ + { + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" + }, + { + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "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 type of the storage provider: primary or image provider", - "name": "type", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "the name of the storage provider", - "name": "name", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" } - ] + ], + "since": "4.4.0" }, { - "description": "List profile in ucs manager", + "description": "List all public, private, and privileged templates.", "isasync": false, - "name": "listUcsProfiles", + "name": "listTemplates", "params": [ { - "description": "the id for the ucs manager", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, - "type": "uuid" + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the template name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -83766,871 +85061,760 @@ "type": "integer" }, { - "description": "", + "description": "flag to list VNF templates or not; true if need to list VNF templates, 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" - }, - { - "description": "ucs profile dn", - "name": "ucsdn", - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "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 IDs of the templates, mutually exclusive with id", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "related": "registerUserKeys", - "response": [ + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "since": "4.9", + "type": "list" + }, { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "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 account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "gslbstickysessionmethodname", + "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "gslblbmethod", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the global load balancer rule", + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "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": "the template ID", "length": 255, "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" + "description": "list templates by zoneId", + "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": "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": "global load balancer rule ID", - "name": "id", - "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": "GSLB service type", - "name": "gslbservicetype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", - "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 id of the load balancer", - "name": "projectid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", "type": "string" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, - {}, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id of the load balancer", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the load balancer rule", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "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": "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": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the project name of the load balancer", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" + "type": "set" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", - "params": [ - { - "description": "an optional project for condition", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "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 domain ID of the account.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Threshold Value for the counter.", - "name": "threshold", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "zone id of counter", + "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, - {}, { - "description": "the project id of the Condition.", - "name": "projectid", + "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 ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the project name of the template", + "name": "project", "type": "string" - } - ] - }, - { - "description": "Lists projects and provides detailed information for listed projects", - "isasync": false, - "name": "listProjects", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "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, + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "list projects by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "list projects by name", - "length": 255, - "name": "name", - "required": false, + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "List projects by username", - "length": 255, - "name": "username", - "required": false, + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "list projects by project ID", - "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "list projects by state", - "length": 255, - "name": "state", - "required": false, + "description": "the project id of the template", + "name": "projectid", "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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "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": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + {}, { - "description": "List projects by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "response": [ - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the template ID", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the date this project was created", + "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + } + ] + }, + { + "description": "create Tungsten-Fabric policy", + "isasync": true, + "name": "createTungstenFabricPolicy", + "params": [ + { + "description": "Tungsten-Fabric policy name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listTungstenFabricPolicy", + "response": [ { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {}, + {}, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - }, + } + ] + }, + { + "description": "deletes a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "deleteASNRange", + "params": [ { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, + "description": "ID of the AS range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the name of the project", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the id of the project", - "name": "id", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a bucket in the specified object storage pool. ", + "isasync": true, + "name": "createBucket", + "params": [ { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the project associated with the bucket. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "Enable bucket versioning", + "length": 255, + "name": "versioning", + "required": false, + "type": "boolean" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "Bucket Quota in GB", + "length": 255, + "name": "quota", + "required": false, + "type": "integer" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "Enable bucket encryption", + "length": 255, + "name": "encryption", + "required": false, + "type": "boolean" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "Id of the Object Storage Pool where bucket is created", + "length": 255, + "name": "objectstorageid", + "related": "addObjectStoragePool", + "required": true, + "type": "uuid" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "The Bucket access policy", + "length": 255, + "name": "policy", + "required": false, "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "Enable object locking in bucket", + "length": 255, + "name": "objectlocking", + "required": false, + "type": "boolean" + } + ], + "related": "listBuckets", + "response": [ + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "ID of the Bucket", + "name": "id", + "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "Bucket URL", + "name": "url", + "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 bucket", + "name": "project", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, { - "description": "the list of resource tags associated with vm", + "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": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -84644,969 +85828,1748 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ + }, + {}, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "Bucket Quota in GB", + "name": "quota", + "type": "integer" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "Bucket Access Policy", + "name": "policy", "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, + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, - "type": "string" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "State of the Bucket", + "name": "state", "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": "email", - "length": 255, - "name": "email", - "required": true, + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" - } - ], - "related": "enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "Total size of objects in Bucket", + "name": "size", "type": "long" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the id of the account", - "name": "id", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "Object storage provider", + "name": "provider", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Lists physical networks", + "isasync": false, + "name": "listPhysicalNetworks", + "params": [ { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the name of the account", + "description": "search by name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "list physical network by id", + "length": 255, + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updatePhysicalNetwork", + "response": [ { - "description": "the state of the account", - "name": "state", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "name of the physical network", + "name": "name", "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, - {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the current status of the latest async job 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": "Lists all firewall rules for an IP address.", + "isasync": false, + "name": "listFirewallRules", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "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 vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, + "type": "uuid" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "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 total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "list firewall rules for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.3", + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of IP address of the firewall services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "createFirewallRule,updateEgressFirewallRule", + "response": [ { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, + {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "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", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account name of the user", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the user", + "description": "the domain associated with the tag", "name": "domain", "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 name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the state of the rule", + "name": "state", + "type": "string" }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + } + ] + }, + { + "description": " delete a Brocade VCS Switch", + "isasync": true, + "name": "deleteBrocadeVcsDevice", + "params": [ + { + "description": "Brocade Switch ID", + "length": 255, + "name": "vcsdeviceid", + "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 the account can own", - "name": "vpclimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", "params": [ { - "description": "The ID of the vm snapshot", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "Lists Routing firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, + "type": "uuid" + }, + { + "description": "list Routing firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list Routing firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "", + "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" } ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, - {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ + { + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + } + ], + "related": "downloadImageStoreObject,extractSnapshot,extractTemplate", + "response": [ + { + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the status of the extraction", + "name": "status", "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, + {}, + {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the id of extracted object", + "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 upload id of extracted object", + "name": "extractId", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the date when this virtual machine was created", + "description": "the time and date the object was created", "name": "created", "type": "date" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the state of the extracted object", + "name": "state", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" + } + ] + }, + { + "description": "Creates an affinity/anti-affinity group", + "isasync": true, + "name": "createAffinityGroup", + "params": [ + { + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "length": 255, + "name": "type", + "required": true, + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "domainId of the account owning the affinity group", + "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": "name of the affinity group", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "optional description of the affinity group", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "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": "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": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, + "type": "string" + }, + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" + }, + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" + }, + { + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Is two factor authentication enabled", + "name": "is2faenabled", + "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": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" + }, + { + "description": "User ID", + "name": "userid", + "type": "string" + }, + { + "description": "Username", + "name": "username", + "type": "string" + }, + { + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", + "type": "string" + }, + { + "description": "user time zone", + "name": "timezone", + "type": "string" + }, + { + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" + }, + { + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" + }, + { + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" + }, + { + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" + }, + {}, + { + "description": "the account name the user belongs to", + "name": "account", + "type": "string" + }, + { + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + {}, + { + "description": "last name of the user", + "name": "lastname", + "type": "string" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all available Internal Load Balancer elements.", + "isasync": false, + "name": "listInternalLoadBalancerElements", + "params": [ + { + "description": "list internal load balancer elements by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list internal load balancer elements by id", + "length": 255, + "name": "id", + "related": "listInternalLoadBalancerElements", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list internal load balancer elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listTrafficTypes", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, + { + "description": "the 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Gets the guest OS names in the hypervisor", + "isasync": true, + "name": "getHypervisorGuestOsNames", + "params": [ + { + "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": "Hypervisor type. One of : VMware, XenServer", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "Keyword for guest os name", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the guest OS list of the hypervisor", + "name": "guestoslist", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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": "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", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Create Tungsten-Fabric provider in cloudstack", + "isasync": false, + "name": "createTungstenFabricProvider", + "params": [ + { + "description": "Tungsten-Fabric provider introspect port", + "length": 255, + "name": "tungstenproviderintrospectport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "length": 255, + "name": "tungstenprovidervrouterport", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric provider gateway", + "length": 255, + "name": "tungstengateway", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "name": "tungstenproviderhostname", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider port", + "length": 255, + "name": "tungstenproviderport", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider name", + "name": "name", + "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": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "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": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", + "params": [ + { + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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.11" + }, + { + "description": "Reboots a virtual machine.", + "isasync": true, + "name": "rebootVirtualMachine", + "params": [ + { + "description": "Force reboot the VM (VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" + } + ], + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + {}, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the 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 account owning the security group", - "name": "account", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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 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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -85615,23 +87578,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -85650,164 +87608,132 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the 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 number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the 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 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": "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, - { - "description": "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -85816,13 +87742,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -85830,14 +87756,24 @@ "name": "customer", "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], @@ -85853,290 +87789,318 @@ "name": "cidr", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - {}, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the disk 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 ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the 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 group ID of the virtual machine", - "name": "groupid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the type of the nic", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "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 project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the affinity group", + "name": "id", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -86145,53 +88109,48 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -86200,413 +88159,326 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "set" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "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", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Lists host tags", - "isasync": false, - "name": "listHostTags", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "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" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - {}, { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, - {}, { - "description": "the ID of the host tag", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if the host tag is implicit", - "name": "isimplicit", - "type": "boolean" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the name of the host tag", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Add a new guest OS type", - "isasync": true, - "name": "addGuestOs", - "params": [ - { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "Optional name for Guest OS", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "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": "publicip", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "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" - } - ], - "since": "4.4.0" - }, - { - "description": "add an annotation.", - "isasync": false, - "name": "addAnnotation", - "params": [ - { - "description": "the annotation is visible for admins only", - "length": 255, - "name": "adminsonly", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, - { - "description": "The 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, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the annotation text", - "length": 255, - "name": "annotation", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the id of the entity to annotate", - "length": 255, - "name": "entityid", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" - } - ], - "related": "removeAnnotation,updateAnnotationVisibility", - "response": [ + }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "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 (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "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" } - ], - "since": "4.11" + ] }, { - "description": "Removes a Guest OS Mapping.", - "isasync": true, - "name": "removeGuestOsMapping", + "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "addVirtualMachinesToKubernetesCluster", "params": [ { - "description": "ID of the guest OS mapping", + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "list" + }, + { + "description": "Is control node or not? Defaults to false.", + "length": 255, + "name": "iscontrolnode", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "required": true, "type": "uuid" } @@ -86617,10 +88489,11 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "true if operation is executed successfully", @@ -86628,343 +88501,444 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, {} ], - "since": "4.4.0" + "since": "4.19.0" }, { - "description": "Recover a Shared FileSystem by id", + "description": "list Tungsten-Fabric logical router", "isasync": false, - "name": "recoverSharedFileSystem", + "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of the shared filesystem to recover", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "name": "networkuuid", + "required": false, + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": false, + "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": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + {}, + { + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", + "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", + "description": "Adds a guest OS name to hypervisor OS name mapping", + "isasync": true, + "name": "addGuestOsMapping", "params": [ { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, - "name": "isextractable", + "name": "forced", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" - }, - { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the ID of the zone you wish to register the ISO to.", + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, "type": "uuid" }, { - "description": "Image store UUID", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "imagestoreuuid", - "required": false, + "name": "osnameforhypervisor", + "required": true, "type": "string" }, { - "description": "the name of the ISO", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", "length": 255, - "name": "name", + "name": "hypervisorversion", "required": true, "type": "string" }, { - "description": "Register ISO for the project", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "osdisplayname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if you want this ISO to be featured", + "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": "isfeatured", + "name": "osmappingcheckenabled", "required": false, + "since": "4.19.0", "type": "boolean" + } + ], + "related": "updateGuestOsMapping", + "response": [ + { + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, + {}, { - "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 checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "List all public, private, and privileged VNF templates.", + "isasync": false, + "name": "listVnfTemplates", + "params": [ + { + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "bootable", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "", "length": 255, - "name": "isdynamicallyscalable", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "show removed templates as well", "length": 255, - "name": "directdownload", + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "passwordenabled", + "name": "parenttemplateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ispublic", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "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", + "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 status of the template", - "name": "status", + "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": "the project name of the template", - "name": "project", - "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 account name to which the template belongs", - "name": "account", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the IDs of the templates, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "since": "4.9", + "type": "list" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "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 template ID", - "name": "id", - "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": "pagesize", + "required": false, + "type": "integer" }, { "description": "the type of the template", + "length": 255, "name": "templatetype", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "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 template ID", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { "description": "if root disk template, then ids of the datas disk templates this template owns", "name": "childtemplates", "type": "set" }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, { "description": "true if the ISO is bootable, false otherwise", "name": "bootable", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { @@ -86972,120 +88946,14 @@ "name": "zonename", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, { "description": "the size of the template", "name": "size", "type": "long" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - {}, - { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "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" }, { @@ -87098,13 +88966,13 @@ "name": "tags", "response": [ { - "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": "tag value", + "name": "value", "type": "string" }, { @@ -87113,28 +88981,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -87143,595 +89011,407 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Creates new NS Vpx", - "isasync": true, - "name": "deployNetscalerVpx", - "params": [ - { - "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 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 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": "the ID of the OS type for this template.", + "name": "ostypeid", + "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 physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, - {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "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 device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the project id of the template", + "name": "projectid", "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": "Lists the volumes of elastistor", - "isasync": false, - "name": "listElastistorVolume", - "params": [ - { - "description": "the ID of the account", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, { - "description": "deduplication", - "name": "deduplication", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "synchronization", - "name": "sync", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, - {}, { - "description": "graceallowed", - "name": "graceallowed", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the id of the volume", - "name": "id", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - {}, { - "description": "the name of the volume", + "description": "the template name", "name": "name", "type": "string" - } - ] - }, - { - "description": "add a baremetal pxe server", - "isasync": true, - "name": "addBaremetalPxeKickStartServer", - "params": [ + }, { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + {}, { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "device id of ", + "description": "the template ID", "name": "id", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "name of the provider", - "name": "provider", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, - {}, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - } - ] - }, - { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", - "params": [ - { - "description": "Id of the portable ip range", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, - {}, {} - ] + ], + "since": "4.19.0" }, { - "description": "Lists Nicira NVP devices", - "isasync": false, - "name": "listNiciraNvpDevices", + "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "isasync": true, + "name": "deployVnfAppliance", "params": [ { - "description": "nicira nvp device ID", + "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": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "rootdisksize", "required": false, - "type": "uuid" + "since": "4.4", + "type": "long" }, { - "description": "", + "description": "availability zone for the virtual machine", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "type": "integer" + "since": "4.12", + "type": "string" }, { - "description": "the Physical Network ID", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, "type": "string" - } - ], - "related": "addNiciraNvpDevice", - "response": [ - { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", - "type": "string" - }, - { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", - "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the controller Ip address", - "name": "hostname", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "device name", - "name": "niciradevicename", + "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": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "Lists all alerts.", - "isasync": false, - "name": "listAlerts", - "params": [ { - "description": "list by alert name", + "description": "host name for the virtual machine", "length": 255, "name": "name", "required": false, - "since": "4.3", "type": "string" }, { - "description": "", + "description": "Deploy vm for the project", "length": 255, - "name": "page", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list 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" }, { - "description": "the ID of the alert", + "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": "id", - "related": "listAlerts", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "Controls specific policies on IO", "length": 255, - "name": "pagesize", + "name": "iodriverpolicy", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "keyword", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "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 id of the alert", - "name": "id", - "type": "string" - }, - { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" - }, - { - "description": "description of the alert", - "name": "description", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "since": "4.18", "type": "integer" }, { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the 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": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "deployVirtualMachine", - "params": [ { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "keyboard", + "name": "ip6address", "required": false, "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "dynamicscalingenabled", + "name": "deploymentplanner", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", "length": 255, - "name": "bootintosetup", + "name": "bootmode", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.14.0.0", + "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "datadiskofferinglist", "required": false, - "type": "list" + "since": "4.11", + "type": "map" }, { "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", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, - { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" - }, { "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, @@ -87741,487 +89421,491 @@ "type": "map" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "hypervisor", + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "iptonetworklist", "required": false, - "since": "4.13", - "type": "uuid" + "type": "map" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "used to specify the vApp properties.", "length": 255, - "name": "nicmultiqueuenumber", + "name": "properties", "required": false, - "since": "4.18", - "type": "integer" + "since": "4.15", + "type": "map" }, { - "description": "Enable packed virtqueues or not.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "dynamicscalingenabled", "required": false, - "since": "4.18", + "since": "4.16", "type": "boolean" }, { - "description": "Controls specific policies on IO", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "iodriverpolicy", + "name": "displayname", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "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": "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": "customid", + "name": "vnfconfiguremanagement", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "userdatadetails", + "name": "copyimagetags", "required": false, - "since": "4.18", - "type": "map" + "since": "4.13", + "type": "boolean" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "displayvm", "required": false, - "type": "list" + "since": "4.2", + "type": "boolean" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "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": "bootmode", + "name": "boottype", "required": false, "since": "4.14.0.0", "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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": "size", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "long" + "type": "list" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "nicnetworklist", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.15", - "type": "map" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, "type": "uuid" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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": "copyimagetags", + "name": "vnfcidrlist", "required": false, - "since": "4.13", - "type": "boolean" + "type": "list" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "the ID of the Userdata", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "userdataid", + "related": "", "required": false, + "since": "4.18", "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "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": "ip6address", + "name": "dhcpoptionsnetworklist", "required": false, - "type": "string" + "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": "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": "datadiskofferinglist", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.11", - "type": "map" + "type": "list" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", "required": false, "type": "string" }, { - "description": "the mac address for default vm's network", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "macaddress", + "name": "userdatadetails", "required": false, - "type": "string" + "since": "4.18", + "type": "map" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "the mac address for default vm's network", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "macaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "displayname", + "name": "keyboard", "required": false, "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "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": "dhcpoptionsnetworklist", + "name": "iothreadsenabled", "required": false, - "type": "map" + "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", + "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": "securitygroupids", - "related": "createSecurityGroup", + "name": "affinitygroupnames", + "related": "", "required": false, "type": "list" }, { - "description": "Deploy vm for the project", + "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": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "since": "4.15", + "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "group", + "name": "startvm", "required": false, - "type": "string" + "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.", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "boottype", + "name": "nicpackedvirtqueuesenabled", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "iothreadsenabled", + "name": "keypairs", "required": false, - "type": "boolean" + "since": "4.17", + "type": "list" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "the ID of the 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.12", + "since": "4.17", + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "since": "4.13", - "type": "uuid" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", - "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", - "length": 255, + "description": "ssh key-pairs", "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "used to specify the vApp properties.", - "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.2", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", - "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "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 service offering of the virtual machine", + "name": "serviceofferingname", "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "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, + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" - } - ], - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "response": [ + }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "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": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -88230,13 +89914,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -88250,62 +89929,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -88314,13 +89939,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -88329,13 +89949,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -88347,34 +89962,34 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "security group name", @@ -88385,27 +90000,22 @@ "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -88414,213 +90024,240 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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 account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the account owning the security group", "name": "account", "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "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", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + {}, + {}, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { @@ -88628,28 +90265,28 @@ "name": "nic", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -88657,45 +90294,50 @@ "name": "id", "type": "string" }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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 gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -88703,13 +90345,13 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -88723,92 +90365,81 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "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", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the 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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the 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" }, { @@ -88817,84 +90448,125 @@ "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the 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 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": "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": "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 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 name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, { "description": "the domain ID of the affinity group", "name": "domainid", @@ -88906,9 +90578,14 @@ "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 description of the affinity group", + "name": "description", + "type": "string" }, { "description": "the project ID of the affinity group", @@ -88916,9 +90593,9 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { "description": "the domain name of the affinity group", @@ -88926,166 +90603,91 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, { "description": "the virtual network for the service offering", "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -89094,53 +90696,18 @@ "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the 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 type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -89149,243 +90716,165 @@ "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Upgrades router to use newer template", + "description": "Updates a network offering.", "isasync": false, - "name": "upgradeRouterTemplate", + "name": "updateNetworkOffering", "params": [ { - "description": "upgrades all routers within the specified zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "upgrades router with the specified Id", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", - "required": false, - "type": "uuid" - }, - { - "description": "upgrades all routers owned by the specified domain", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers owned by the specified account", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "account", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { - "description": "upgrades all routers within the specified pod", + "description": "the display text of the network offering", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists IPv4 subnets for guest networks.", - "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", - "params": [ - { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "the id of the network offering", "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "keepaliveenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The CIDR of the Ipv4 subnet.", + "description": "the name of the network offering", "length": 255, - "name": "subnet", + "name": "name", "required": false, "type": "string" }, { - "description": "UUID of network to which the IPv4 subnet is associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of VPC to which the IPv4 subnet is associated to.", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of the IPv4 subnet for guest network.", + "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": "listIpv4SubnetsForGuestNetwork", + "name": "availability", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "update state for the network offering", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.13", + "type": "string" }, { - "description": "", + "description": "sort key of the network offering, integer", "length": 255, - "name": "page", + "name": "sortkey", "required": false, "type": "integer" } ], - "related": "", + "related": "createNetworkOffering,listNetworkOfferings", "response": [ { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, + {}, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, - {}, - {}, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -89393,146 +90882,99 @@ "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" - }, - { - "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "response": [ - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "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", + "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 amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" + "description": "the provider name", + "name": "name", + "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 destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "Model Name of vGPU", - "name": "vgputype", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "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" @@ -89541,205 +90983,150 @@ "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "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 IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, - {}, - {}, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "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 management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "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 host hypervisor", - "name": "hypervisor", + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost", + "response": [ { - "description": "the name of the host", - "name": "name", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "the operation result", + "name": "status", "type": "boolean" }, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -89748,152 +91135,121 @@ "type": "integer" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "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 out-of-band management driver for the host", + "name": "driver", + "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists all VLAN IP ranges.", + "description": "List resource detail(s)", "isasync": false, - "name": "listVlanIpRanges", + "name": "listResourceDetails", "params": [ { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "forvirtualnetwork", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "network id of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "list by resource id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "resourceid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "project who will own the VLAN", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "value", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "physical network id of the VLAN IP range", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "list by key", "length": 255, - "name": "vlan", + "name": "key", "required": false, "type": "string" }, { - "description": "the ID of the VLAN IP range", + "description": "list by resource type", "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -89903,111 +91259,127 @@ "type": "integer" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.3", + "type": "boolean" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "updateVlanIpRange,dedicatePublicIpRange", + "related": "", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, + {}, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "the domain ID of the VLAN IP range", + "description": "the ID of the containing domain", + "length": 255, "name": "domainid", - "type": "string" + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listDedicatedClusters", + "response": [ + { + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { @@ -90015,14 +91387,15 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { @@ -90031,653 +91404,778 @@ "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" - }, - {}, - { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" - }, - { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, {}, { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" } ] }, { - "description": "Updates a Zone.", + "description": "Creates a network offering.", "isasync": false, - "name": "updateZone", + "name": "createNetworkOffering", "params": [ { - "description": "the second DNS for the Zone", + "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": "dns2", + "name": "keepaliveenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "services supported by the network offering", "length": 255, - "name": "ip6dns1", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "sort key of the zone, integer", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "sortkey", + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", "required": false, "type": "integer" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "domain", + "name": "routingmode", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the dns search order list", + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", "length": 255, - "name": "dnssearchorder", + "name": "internetprotocol", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "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": "updates a private zone to public if set, but not vice-versa", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "ispublic", + "name": "fortungsten", "required": false, "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "guestcidraddress", + "name": "ispersistent", + "required": false, + "type": "boolean" + }, + { + "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 ID of the Zone", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "egressdefaultpolicy", + "required": false, + "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "dhcpprovider", + "name": "servicecapabilitylist", "required": false, - "type": "string" + "type": "map" }, { - "description": "the first DNS for the Zone", + "description": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "dns1", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the Zone", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "name", + "name": "enable", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "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": "internaldns1", + "name": "availability", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "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": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", "length": 255, "name": "details", "required": false, + "since": "4.2.0", "type": "map" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", "length": 255, - "name": "localstorageenabled", + "name": "nsxsupportsinternallb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "allocationstate", + "name": "networkrate", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the second internal DNS for the Zone", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "internaldns2", + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the display text of the network offering, defaults to the value of 'name'.", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "true if network offering supports choosing AS number", "length": 255, - "name": "ip6dns2", + "name": "specifyasnumber", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the service offering ID used by virtual router provider", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "true if network offering is meant to be used for NSX, false otherwise.", + "length": 255, + "name": "fornsx", "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, "type": "string" + }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" + }, + { + "description": "true if network offering supports vlans", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" } ], - "related": "createZone,listZones,listZones", + "related": "listNetworkOfferings", "response": [ { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "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 choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "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 allocation state of the cluster", - "name": "allocationstate", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "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": "the first DNS for the Zone", - "name": "dns1", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "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": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the list of supported services", + "name": "service", "response": [ { - "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 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" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the service name", + "name": "name", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", + "params": [ + { + "description": "the end port for the rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "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.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "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 capacity of the Zone", - "name": "capacity", + "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": "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": "createPortForwardingRule,updatePortForwardingRule", + "response": [ + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "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 total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - {}, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "Zone id", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - } - ] - }, - { - "description": "Extracts volume", - "isasync": true, - "name": "extractVolume", - "params": [ - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the ID of the volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the zone where the volume is located", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", - "response": [ - { - "description": "type of the storage", - "name": "storagetype", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "", - "name": "resultstring", + "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", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the id of extracted object", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, {}, { - "description": "the state of the extracted object", - "name": "state", - "type": "string" - }, - { - "description": "the status of the extraction", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" } ] }, { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", - "isasync": true, - "name": "releaseIpv4SubnetForZone", + "description": "Lists the network Interfaces of elastistor", + "isasync": false, + "name": "listElastistorInterface", "params": [ { - "description": "Id of the guest network IPv4 subnet", + "description": "controller id", "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, - "type": "uuid" + "name": "controllerid", + "required": false, + "type": "string" } ], - "related": "createIpv4SubnetForZone,dedicateIpv4SubnetForZone", + "related": "listElastistorVolume", "response": [ { - "description": "id of the guest IPv4 subnet", + "description": "the id of the volume", "name": "id", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" - }, - { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "compression", + "name": "compression", "type": "string" }, - {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "synchronization", + "name": "sync", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "deduplication", + "name": "deduplication", "type": "string" }, {}, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the name of the volume", + "name": "name", "type": "string" }, { @@ -90685,284 +92183,392 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" - } - ], - "since": "4.20.0" + {} + ] }, { - "description": "Lists project's accounts", + "description": "Create a quota statement", "isasync": false, - "name": "listProjectAccounts", + "name": "quotaStatement", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list accounts of the project by project role id", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", - "required": false, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, "type": "uuid" }, { - "description": "list invitation by user ID", + "description": "List quota usage records for the specified usage type", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "type", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list accounts of the project by account name", + "description": "Optional, Account Id for which statement needs to be generated", "length": 255, "name": "account", - "required": false, + "required": true, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list accounts of the project by role", + "description": "Start of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "role", - "required": false, - "type": "string" + "name": "startdate", + "required": true, + "type": "date" }, { - "description": "", + "description": "List usage records for the specified account", "length": 255, - "name": "pagesize", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "ID of the project", + "description": "End of the period of the Quota statement. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "enddate", "required": true, - "type": "uuid" + "type": "date" } ], - "related": "activateProject,suspendProject,updateProject", + "related": "", "response": [ { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "account id", + "name": "accountid", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, + "description": "domain id", + "name": "domain", + "type": "long" + }, + {}, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "account name", + "name": "account", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "usage unit", + "name": "unit", "type": "string" }, + {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "usage type name", + "name": "name", + "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "usage type", + "name": "type", + "type": "int" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.7.0" + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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 displaytext of the project", - "name": "displaytext", + "description": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "required": true, + "type": "uuid" + } + ], + "related": "createLBStickinessPolicy", + "response": [ + { + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "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": "the domain associated with the tag", - "name": "domain", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" } ], "type": "list" }, + {} + ], + "since": "4.4" + }, + { + "description": "Lists all Pods.", + "isasync": false, + "name": "listPods", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Pods by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, - {}, - {}, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "flag to display the capacity of the pods", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "list pods by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "list Pods by ID", + "length": 255, + "name": "id", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "list Pods by Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createManagementNetworkIpRange", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + } + ], + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -90970,937 +92576,1095 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the name of the Pod", + "name": "name", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, + {}, + {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "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 tagged resource limit and count for the project", - "name": "taggedresources", + "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 state of the project", - "name": "state", - "type": "string" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + } + ] + }, + { + "description": "delete Tungsten-Fabric address group", + "isasync": true, + "name": "deleteTungstenFabricAddressGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "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 total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Lists all quota tariff plans", + "isasync": false, + "name": "quotaTariffList", + "params": [ + { + "description": "If set to true, we will list only the removed tariffs. The default is false.", + "length": 255, + "name": "listonlyremoved", + "required": false, + "type": "boolean" }, { - "description": "the id of the project", + "description": "The quota tariff's id.", + "length": 255, "name": "id", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "The start date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "Usage type of the resource", + "length": 255, + "name": "usagetype", + "required": false, + "type": "integer" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an existing autoscale policy.", - "isasync": true, - "name": "updateAutoScalePolicy", - "params": [ - { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", "length": 255, - "name": "quiettime", + "name": "listall", "required": false, - "type": "integer" + "since": "4.18.0.0", + "type": "boolean" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "List by keyword", "length": 255, - "name": "conditionids", - "related": "", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the autoscale policy", + "description": "", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the autoscale policy", + "description": "The name of the quota tariff.", "length": 255, "name": "name", "required": false, - "since": "4.18.0", + "since": "4.18.0.0", "type": "string" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "The end date of the quota tariff. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "duration", + "name": "enddate", "required": false, - "type": "integer" + "since": "4.18.0.0", + "type": "date" } ], - "related": "listAutoScalePolicies", + "related": "", "response": [ { - "description": "the domain name of the autoscale policy", - "name": "domain", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "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 cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", "type": "integer" }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, + { + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description", + "name": "description", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, {}, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the ID of the tariff", + "name": "id", + "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "usageUnit", + "name": "usageUnit", + "type": "string" + }, + {}, + { + "description": "usageName", + "name": "usageName", + "type": "string" + }, + { + "description": "currency", + "name": "currency", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ], + "since": "4.7.0" + }, + { + "description": "Stops a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "stopKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "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": "Creates a IPv4 subnet for a zone.", - "isasync": true, - "name": "createIpv4SubnetForZone", + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", "params": [ { - "description": "project who will own the IPv4 subnet", + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The CIDR of the IPv4 subnet.", + "description": "List by keyword", "length": 255, - "name": "subnet", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "account who will own the IPv4 subnet", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "domain ID of the account owning the IPv4 subnet", + "description": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the domain ID which the IPv4 subnet is dedicated to.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "UUID of the zone which the IPv4 subnet belongs to.", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, "type": "uuid" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" } ], "related": "dedicateIpv4SubnetForZone", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, + {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, - {}, { "description": "id of zone to which the IPv4 subnet belongs to.", "name": "zoneid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" } ], "since": "4.20.0" }, { - "description": "Creates a disk offering.", - "isasync": false, - "name": "createDiskOffering", + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", "params": [ { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "name of the account to be added to the project", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "ID of the project to add the account to", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "list" + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" }, { - "description": "burst bytes read rate of the disk offering", + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", "length": 255, - "name": "bytesreadratemax", + "name": "roletype", "required": false, - "type": "long" + "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "disksizestrictness", + "name": "email", "required": false, - "since": "4.17", - "type": "boolean" + "type": "string" }, { - "description": "whether disk offering size is custom or not", + "description": "ID of the project role", "length": 255, - "name": "customized", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "boolean" - }, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, + "description": "any text associated with the success or failure", "name": "displaytext", - "required": false, "type": "string" }, { - "description": "min iops of the disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "max iops of the disk offering", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists all available snapshots for the account.", + "isasync": false, + "name": "listSnapshots", + "params": [ + { + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "maxiops", + "name": "tags", "required": false, - "type": "long" + "type": "map" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "ID of the image or image cache store", "length": 255, - "name": "storagepolicy", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "since": "4.15", + "since": "4.19", "type": "uuid" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "", "length": 255, - "name": "cachemode", + "name": "page", "required": false, - "since": "4.14", - "type": "string" + "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", + "description": "list snapshots by zone id", "length": 255, - "name": "iopswriteratemax", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "storagetype", + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "details to specify disk offering parameters", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "details", + "name": "snapshottype", "required": false, - "since": "4.16", - "type": "map" + "type": "string" }, { - "description": "whether disk offering iops is custom or not", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "customizediops", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "bytes write rate of the disk offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "byteswriterate", + "name": "projectid", + "related": "createProject", "required": false, - "type": "long" - }, - { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "disksize", - "required": false, - "type": "long" - }, - { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "name": "intervaltype", "required": false, "type": "string" }, { - "description": "Volumes using this offering should be encrypted", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "encrypt", + "name": "listall", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "displayoffering", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "", "length": 255, - "name": "iopswriteratemaxlength", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "isrecursive", "required": false, - "since": "4.13", - "type": "list" + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of the disk volume", "length": 255, - "name": "bytesreadratemaxlength", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "ID of the storage pool", "length": 255, - "name": "byteswriteratemax", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "long" + "since": "4.19", + "type": "uuid" }, { - "description": "burst requests read rate of the disk offering", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "iopsreadratemax", + "name": "showunique", "required": false, - "type": "long" + "since": "4.19.0", + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "iopsreadrate", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "provisioningtype", + "name": "account", "required": false, "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "List by keyword", "length": 255, - "name": "iopswriterate", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "bytesreadrate", + "name": "locationtype", "required": false, - "type": "long" + "since": "4.19.0", + "type": "string" } ], - "related": "", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, + {}, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the account associated with the snapshot", + "name": "account", + "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": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "state of the disk offering", - "name": "state", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" }, - {}, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date this disk offering was created", + "description": " the date the snapshot was created", "name": "created", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" - }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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" }, + {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "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 status of the template", + "name": "status", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "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": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, - {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "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 tags for the disk offering", - "name": "tags", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" } ] }, { - "description": "Lists all volumes.", - "isasync": false, - "name": "listVolumes", + "description": "migrates resources from one secondary storage to destination image store", + "isasync": true, + "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "id(s) of the snapshots to be migrated", "length": 255, - "name": "state", + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "required": false, - "type": "string" + "type": "list" }, { - "description": "list volumes on specified host", + "description": "id of the destination secondary storage pool to which the resources are to be migrated", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "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": "id of the image store from where the data is to be migrated", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "id(s) of the templates to be migrated", "length": 255, - "name": "keyword", + "name": "templates", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, + "type": "list" + } + ], + "related": "migrateSecondaryStorageData", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "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 operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.19.1", - "type": "uuid" - }, - { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "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 display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", - "type": "boolean" - }, + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a keypair by name", + "isasync": false, + "name": "deleteSSHKeyPair", + "params": [ { - "description": "list volumes by disk offering", + "description": "the project associated with keypair", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "Name of the keypair", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the disk volume", + "description": "the domain ID associated with the keypair", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" - }, + } + ], + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Searches LDAP based on the username attribute", + "isasync": false, + "name": "searchLdap", + "params": [ { - "description": "the pod id the disk volume belongs to", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -91910,609 +93674,803 @@ "type": "integer" }, { - "description": "list only volumes that are encrypted", - "length": 255, - "name": "isencrypted", - "required": false, - "since": "4.19.1", - "type": "boolean" - }, - { - "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 storage pool, available to ROOT admin only", + "description": "List by keyword", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "keyword", "required": false, - "since": "4.3", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "query to search using", "length": 255, - "name": "account", - "required": false, + "name": "query", + "related": "searchLdap", + "required": true, "type": "string" } ], - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "", "response": [ { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "The user's domain", + "name": "domain", + "type": "string" }, + {}, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "The user's principle", + "name": "principal", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, + "description": "The user's firstname", + "name": "firstname", + "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "type": "uuid" + } + ], + "related": "prepareForShutdown", + "response": [ + {}, + { + "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 volume to the end user or not.", - "name": "displayvolume", + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, { - "description": "size of the disk volume", - "name": "size", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Tungsten-Fabric logical router name", + "name": "name", "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": "name of the virtual machine", - "name": "vmname", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "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": "cluster id of the volume", - "name": "clusterid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {} + ] + }, + { + "description": "Start a Shared FileSystem", + "isasync": true, + "name": "startSharedFileSystem", + "params": [ + { + "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 list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the nic", + "name": "id", "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the 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 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "type": "list" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the storage fs data volume", + "name": "volumeid", "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", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the bytes allocated", + "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": "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 VM's disk write in KiB", - "name": "diskkbswrite", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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" + } + ], + "type": "set" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "create Tungsten-Fabric firewall", + "isasync": true, + "name": "createTungstenFabricFirewallRule", + "params": [ { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "Tungsten-Fabric firewall rule tag type uuid", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Tungsten-Fabric firewall rule destination tag uuid", + "length": 255, + "name": "desttaguuid", + "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.", - "name": "templateid", + "description": "Tungsten-Fabric firewall rule destination address group uuid", + "length": 255, + "name": "destaddressgroupuuid", + "required": false, "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the uuid of Tungsten-Fabric destination network", + "length": 255, + "name": "destnetworkuuid", + "required": false, "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" - } - ] - }, - { - "description": "Creates a load balancer health check policy", - "isasync": true, - "name": "createLBHealthCheckPolicy", - "params": [ - { - "description": "HTTP ping path", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "pingpath", + "name": "srcaddressgroupuuid", "required": false, "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "unhealthythreshold", - "required": false, + "name": "sequence", + "required": true, "type": "integer" }, { - "description": "the description of the load balancer health check policy", + "description": "the ID of zone", "length": 255, - "name": "description", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric firewall rule source tag uuid", + "length": 255, + "name": "srctaguuid", "required": false, "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", + "name": "firewallpolicyuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "intervaltime", - "required": false, - "type": "integer" + "name": "servicegroupuuid", + "required": true, + "type": "string" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "responsetimeout", + "name": "srcnetworkuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "direction", + "required": true, + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "healthythreshold", - "required": false, - "type": "integer" + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], - "related": "listLBHealthCheckPolicies", + "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "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 description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - } - ], - "type": "list" + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, {}, { - "description": "the id of the zone the HealthCheck policy belongs to", + "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", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, {}, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { @@ -92521,2165 +94479,2053 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", + "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Lists details of network protocols", + "description": "Lists all configurations.", "isasync": false, - "name": "listNetworkProtocols", + "name": "listConfigurations", "params": [ { - "description": "The option of network protocols. Supported values are: protocolnumber, icmptype.", + "description": "List by keyword", "length": 255, - "name": "option", - "required": true, + "name": "keyword", + "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the name of the protocol parameter", - "name": "name", + "description": "lists configurations by category", + "length": 255, + "name": "category", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by subgroup name (primarily used for UI)", + "length": 255, + "name": "subgroup", + "required": false, + "since": "4.18.0", "type": "string" }, - {}, { - "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", - "name": "index", + "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": "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 description of the protocol parameter", - "name": "description", + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the details of the protocol parameter", - "name": "details", - "type": "map" - } - ], - "since": "4.19.0" - }, - { - "description": "Change Service offering of a Shared FileSystem", - "isasync": true, - "name": "changeSharedFileSystemServiceOffering", - "params": [ + "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": "the offering to use for the shared filesystem instance", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "the ID of the shared filesystem", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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" } ], - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "related": "", "response": [ { - "description": "ID of the shared filesystem", + "description": "the display text of the configuration", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the default value of the configuration", + "name": "defaultvalue", + "type": "string" + }, + { + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + { + "description": "the group of the configuration", + "name": "group", + "type": "string" + }, + { + "description": "the value of the configuration", "name": "id", + "type": "long" + }, + {}, + { + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 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": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the 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": "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - } - ], - "type": "list" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, { - "description": "name of the shared filesystem", + "description": "the name of the configuration", "name": "name", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, - {}, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" + } + ] + }, + { + "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "scaleKubernetesCluster", + "params": [ + { + "description": "Maximum number of worker nodes in the cluster", + "length": 255, + "name": "maxsize", + "required": false, + "type": "long" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "the IDs of the nodes to be removed", + "length": 255, + "name": "nodeids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "list" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, + { + "description": "Minimum number of worker nodes in the cluster", + "length": 255, + "name": "minsize", + "required": false, "type": "long" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" + "description": "number of Kubernetes cluster nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "Whether autoscaling is enabled for the cluster", + "length": 255, + "name": "autoscalingenabled", + "required": false, + "type": "boolean" + }, + { + "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" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster", + "response": [ + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "service offering for the shared filesystem", + "description": "the name of the service offering of the Kubernetes cluster", "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "size of the shared filesystem", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", "name": "size", "type": "long" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, + {}, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" }, {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "Locks a user account", - "isasync": false, - "name": "lockUser", + "description": "Stops a NetScalervm.", + "isasync": true, + "name": "stopNetScalerVpx", "params": [ { - "description": "Locks user by user ID.", + "description": "the ID of the NetScaler vm", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" + }, + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - {}, { - "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 account ID of the user", - "name": "accountid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "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 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 guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, - {}, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the hostname for the router", + "name": "hostname", + "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 ID", - "name": "id", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" - } - ] - }, - { - "description": "Checks if the Cloudian Connector is enabled", - "isasync": false, - "name": "cloudianIsEnabled", - "params": [], - "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 Cloudian Management Console base URL", - "name": "url", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" - } - ], - "since": "4.11.0" - }, - { - "description": "Lists load balancer health check policies.", - "isasync": false, - "name": "listLBHealthCheckPolicies", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the health check policy", - "length": 255, - "name": "id", - "related": "listLBHealthCheckPolicies", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "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, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - {}, - {}, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the 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 domain of the HealthCheck policy", - "name": "domain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the LB HealthCheck policy ID", + "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 the nic", + "name": "gateway", + "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 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": "the name of the corresponding network", + "name": "networkname", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], - "type": "list" - } - ], - "since": "4.2.0" - }, - { - "description": "Creates a network", - "isasync": false, - "name": "createNetwork", - "params": [ + "type": "set" + }, { - "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, + "description": "the gateway for the router", + "name": "gateway", "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": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the zone ID for the network", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "gateway", - "required": false, + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "length": 255, + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", "name": "ip6dns1", - "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "IPV6 address to be assigned to a router in a shared network", - "length": 255, - "name": "routeripv6", - "required": false, - "since": "4.16", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", - "length": 255, - "name": "bypassvlanoverlapcheck", - "required": false, - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "Network ACL ID associated for the network", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "length": 255, - "name": "tungstenvirtualrouteruuid", - "required": false, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + } + ] + }, + { + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", + "params": [ + { + "description": "the ID of the instance group", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.17.0", + "name": "id", + "related": "updateInstanceGroup", + "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the second IPv6 DNS for the network", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional project for the network", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "Ids of the Bgp Peer for the network", - "length": 255, - "name": "bgppeerids", - "related": "updateBgpPeer", - "required": false, - "since": "4.20.0", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "Updates traffic type of a physical network", + "isasync": true, + "name": "updateTrafficType", + "params": [ { - "description": "the beginning IP address in the network IP range", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "startip", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "traffic type id", "length": 255, - "name": "cidrsize", - "required": false, - "since": "4.20.0", - "type": "integer" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "endipv6", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "account", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "the display text of the network", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "displaytext", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "publicmtu", + "name": "kvmnetworklabel", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" + } + ], + "related": "addTrafficType", + "response": [ + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" }, { - "description": "the isolated private VLAN type for this network", - "length": 255, - "name": "isolatedpvlantype", - "required": false, + "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 in an external system.", - "length": 255, - "name": "externalid", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VPC network belongs to", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", - "length": 255, - "name": "netmask", - "required": false, + "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", "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the name of the network", + "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 by keyword", "length": 255, - "name": "name", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the ID of the policy", "length": 255, - "name": "displaynetwork", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hideipaddressusage", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "startipv6", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "endip", + "name": "account", "required": false, "type": "string" }, { - "description": "the AS Number of the network", + "description": "ID of the Condition.", "length": 255, - "name": "asnumber", + "name": "id", + "related": "listConditions", "required": false, - "since": "4.20.0", - "type": "long" + "type": "uuid" }, { - "description": "the isolated private VLAN for this network", + "description": "Counter-id of the condition.", "length": 255, - "name": "isolatedpvlan", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the physical network ID the network belongs to", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "", "length": 255, - "name": "subdomainaccess", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "", "length": 255, - "name": "routerip", + "name": "page", "required": false, - "since": "4.16", - "type": "string" + "type": "integer" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "privatemtu", + "name": "listall", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "boolean" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "", "response": [ { - "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the domain id of the Condition owner", + "name": "domainid", "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" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "zone id of counter", + "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 Counter.", + "name": "countername", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "Threshold Value for the counter.", + "name": "threshold", "type": "long" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the owner of the Condition.", + "name": "account", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" + } + ] + }, + { + "description": "migrates data objects from one secondary storage to destination image store(s)", + "isasync": true, + "name": "migrateSecondaryStorageData", + "params": [ { - "description": "the list of services", - "name": "service", - "response": [ - { - "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": "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": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], + "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": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, "type": "string" }, + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "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 ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" }, + {}, + {}, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.15.0" + }, + { + "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": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "required": true, + "type": "uuid" + } + ], + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "response": [ + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the id of the network", - "name": "id", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "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 second IPv4 DNS for the network", - "name": "dns2", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "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 IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, + {}, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the ID of the 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": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, - {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "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" + } + ], "type": "set" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ] - }, - { - "description": "Lists all available network offerings.", - "isasync": false, - "name": "listNetworkOfferings", - "params": [ + }, { - "description": "true if need to list only default network offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", - "required": false, + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "list network offerings by name", - "length": 255, - "name": "name", - "required": false, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "the disk utilization", + "name": "utilization", + "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 project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the tags for the network offering.", - "length": 255, - "name": "specifyvlan", - "required": false, - "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": "list network offerings by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "name of the virtual machine", + "name": "vmname", "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": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "list network offerings supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "list network offerings by guest type: shared or isolated", - "length": 255, - "name": "guestiptype", - "required": false, + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if offering has tags specified", - "length": 255, - "name": "istagged", - "required": false, - "type": "boolean" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the availability of network offering. Default value is required", - "length": 255, - "name": "availability", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Adds traffic type to a physical network", + "isasync": true, + "name": "addTrafficType", + "params": [ + { + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "traffictype", + "required": true, + "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "forvpc", + "name": "xennetworklabel", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "ovm3networklabel", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "list by traffic type", + "description": "the Physical Network ID", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "keyword", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "list network offerings by state", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "state", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "list network offerings by ID", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network offerings available for network creation in specific zone", + "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": "zoneid", - "related": "createZone,listZones,listZones", + "name": "isolationmethod", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "routingmode", + "name": "hypervnetworklabel", "required": false, - "since": "4.20.0", "type": "string" } ], "related": "", "response": [ - { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "id of the network provider", + "name": "id", + "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" }, {}, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists the secondary storage selectors and their rules.", + "isasync": false, + "name": "listSecondaryStorageSelectors", + "params": [ { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "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", - "type": "string" + "description": "The zone ID to be used in the search filter.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "Show removed heuristics.", + "length": 255, + "name": "showremoved", + "required": false, "type": "boolean" - }, - { - "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 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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, - { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, {}, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "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 heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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": "the id of the network offering", - "name": "id", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Lists dedicated pods.", + "description": "List all virtual machine instances that are assigned to a load balancer rule.", "isasync": false, - "name": "listDedicatedPods", + "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the pod", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "lbvmips", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list dedicated pods by affinity group", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "applied", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -94689,49 +96535,40 @@ "type": "integer" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the domain associated with the pod", + "description": "the ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "listLoadBalancerRuleInstances", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" }, - {}, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94740,1322 +96577,1356 @@ "type": "integer" }, { - "description": "the ID of the Pod", - "name": "podid", + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" + } + ] + }, + { + "description": "Removes a condition for VM auto scaling", + "isasync": true, + "name": "deleteCondition", + "params": [ + { + "description": "the ID of the condition.", + "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 Name of the Pod", - "name": "podname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "any text associated 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": "Attempts Migration of a VM with its volumes to a different host", + "description": "Updates a physical network", "isasync": true, - "name": "migrateVirtualMachineWithVolume", + "name": "updatePhysicalNetwork", "params": [ { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "description": "Enabled/Disabled", "length": 255, - "name": "autoselect", + "name": "state", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "the VLAN for the physical network", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "name": "vlan", "required": false, + "type": "string" + }, + { + "description": "physical network id", + "length": 255, + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, "type": "uuid" }, { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "description": "Tag the physical network", "length": 255, - "name": "migrateto", + "name": "tags", "required": false, - "type": "map" + "type": "list" }, { - "description": "the ID of the virtual machine", + "description": "the speed for the physical network[1G/10G]", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "networkspeed", + "required": false, + "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "", "response": [ { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, - {}, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "name of the physical network", + "name": "name", "type": "string" }, + {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the speed of the physical network", + "name": "networkspeed", "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" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Stop a Shared FileSystem", + "isasync": true, + "name": "stopSharedFileSystem", + "params": [ { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "Force stop the shared filesystem.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the 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": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "name of the storage fs data volume", + "name": "volumename", "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 id of userdata used for the VM", - "name": "userdataid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "the domain associated with the shared filesystem", "name": "domain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "tag value", - "name": "value", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" - } - ], - "type": "set" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 project name of the affinity group", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], - "type": "set" + "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the write (IO) of disk on the VM", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" + } + ], + "since": "4.20.0" + }, + { + "description": "create Tungsten-Fabric management network", + "isasync": false, + "name": "createTungstenFabricManagementNetwork", + "params": [ + { + "description": "the ID of pod", + "length": 255, + "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": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the 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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", + "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 source tag", + "name": "srctag", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" + } + ] + }, + { + "description": "Creates a project", + "isasync": true, + "name": "createProject", + "params": [ + { + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "since": "4.15.0", + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "The display text of the project, defaults to the 'name´.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "domain ID of the account owning a project", + "length": 255, + "name": "domainid", + "related": "createDomain,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", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the state of the virtual machine", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the state of the project", "name": "state", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the 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 primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "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 vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the 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 project", + "name": "id", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "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": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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": "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": "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": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], - "type": "set" + "type": "list" }, - {}, { - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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" - } - ], - "type": "set" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - } - ] - }, - { - "description": "Lists VPCs", - "isasync": false, - "name": "listVPCs", - "params": [ + "description": "the project account name of the project", + "name": "projectaccountname", + "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 total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "list VPC supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, + "description": "the account name of the project's owners", + "name": "owner", "type": "list" }, { - "description": "list by name of the VPC", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "list VPCs by restartRequired option", - "length": 255, - "name": "restartrequired", - "required": false, - "type": "boolean" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "list by zone", + "description": "the date this project was created", + "name": "created", + "type": "date" + } + ], + "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": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, + "name": "certid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "list VPC by id", + "description": "the ID of the load balancer rule", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "list VPCs by state", - "length": 255, - "name": "state", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ] + }, + { + "description": "Adds a Cisco Vnmc Controller", + "isasync": false, + "name": "addCiscoVnmcResource", + "params": [ { - "description": "flag to display the resource icon for VPCs", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "password", + "required": true, + "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "List by display text of the VPC", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "displaytext", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Hostname or ip address of the Cisco VNMC Controller.", "length": 255, - "name": "account", - "required": false, + "name": "hostname", + "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": "list by ID of the VPC offering", + "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": "vpcofferingid", - "related": "updateVPCOffering", - "required": false, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "The Zone ID with which the account is to be marked.", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Name of the account that is to be marked.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "name": "account", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": true, + "type": "string" } ], - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "is vpc 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": "zone id of the vpc", - "name": "zoneid", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + {}, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { @@ -96064,526 +97935,564 @@ "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", + "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", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the id of the VPC", - "name": "id", + "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": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "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": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.0" }, { - "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", - "isasync": false, - "name": "addNetworkDevice", + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", "params": [ { - "description": "parameters for network device", + "description": "The certificate CN", "length": 255, - "name": "networkdeviceparameterlist", + "name": "cn", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "The certificate serial number, as a hex value", "length": 255, - "name": "networkdevicetype", + "name": "serial", + "required": true, + "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" } ], - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the network device", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.11.0" }, { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "description": "Deletes a routing firewall rule", "isasync": true, - "name": "runDiagnostics", + "name": "deleteRoutingFirewallRule", "params": [ { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - }, - { - "description": "The ID of the system VM instance to diagnose", + "description": "the ID of the Routing firewall rule", "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" - }, - { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, - { - "description": "Additional command line options that apply for each command", - "length": 255, - "name": "params", - "required": false, - "type": "string" } ], - "related": "", "response": [ - { - "description": "the standard error output from the command execution", - "name": "stderr", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the command execution return code", - "name": "exitcode", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the standard output from the command execution", - "name": "stdout", - "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.12.0.0" + "since": "4.20.0" }, { - "description": "Updates a user account", + "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": "updateUser", + "name": "changeServiceForSystemVm", "params": [ { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "password", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "timezone", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "User uuid", + "description": "The ID of the system vm", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", + "related": "startSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" + } + ], + "related": "startSystemVm", + "response": [ + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", - "length": 255, - "name": "userapikey", - "required": false, + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", - "length": 255, - "name": "currentpassword", - "required": false, + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", - "length": 255, - "name": "mandate2fa", - "required": false, - "since": "4.18.0.0", - "type": "boolean" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "last name", - "length": 255, - "name": "lastname", - "required": false, + "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": "first name", - "length": 255, - "name": "firstname", - "required": false, + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", - "length": 255, - "name": "usersecretkey", - "required": false, + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "Unique username", - "length": 255, - "name": "username", - "required": false, + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": false, + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" - } - ], - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "response": [ + }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -96591,165 +98500,202 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the account name of the user", - "name": "account", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the user email address", - "name": "email", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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 role", - "name": "rolename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the last disconnected date of host", + "name": "disconnected", "type": "date" }, { - "description": "the user ID", - "name": "id", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Restarts a VPC", - "isasync": true, - "name": "restartVPC", + "description": "Update SIOC info", + "isasync": false, + "name": "updateSiocInfo", "params": [ { - "description": "the id of the VPC", + "description": "Zone ID", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "Turn a single VPC into a redundant one.", + "description": "Shares per GB", "length": 255, - "name": "makeredundant", - "required": false, - "type": "boolean" + "name": "sharespergb", + "required": true, + "type": "integer" }, { - "description": "If cleanup old network elements", + "description": "Notify if IOPS above this value", "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" + "name": "iopsnotifythreshold", + "required": true, + "type": "integer" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "Limit IOPS per GB", "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" + "name": "limitiopspergb", + "required": true, + "type": "integer" + }, + { + "description": "Storage Pool ID", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", "type": "string" }, {}, @@ -96758,848 +98704,919 @@ "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" }, { - "description": "Removes a certificate from a load balancer rule", + "description": "Deletes a vmsnapshot.", "isasync": true, - "name": "removeCertFromLoadBalancer", + "name": "deleteVMSnapshot", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the VM snapshot", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + {}, + { + "description": "any text associated 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": "Adds a new host.", - "isasync": false, - "name": "addHost", + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", "params": [ { - "description": "the Pod ID for the host", + "description": "The ID of the virtual machine to unmanage", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", - "required": false, + "description": "details of the unmanage VM operation", + "name": "details", "type": "string" }, + {}, { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "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": "hypervisor type of the host", + "description": "the ID of the router", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "Force reboot the router (Router is force Stopped and then Started)", "length": 255, - "name": "allocationstate", + "name": "forced", "required": false, - "type": "string" - }, + "since": "4.16.0", + "type": "boolean" + } + ], + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ { - "description": "the cluster ID for the host", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "username", - "required": false, + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - } - ], - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "response": [ - { - "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 public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the host", + "description": "the id of the router", "name": "id", "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 router", + "name": "zoneid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, + {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" } ], "type": "list" }, { - "description": "the host version", - "name": "version", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the hostname for the router", + "name": "hostname", "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 account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + } + ] + }, + { + "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "events available for the host", - "name": "events", + "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 nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "name", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" - } - ] - }, - { - "description": "Attaches a disk volume to a virtual machine.", - "isasync": true, - "name": "attachVolume", - "params": [ + }, { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": " the ID of the virtual machine", - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "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 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": "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": "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" - }, - { - "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "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": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" - }, + } + ] + }, + { + "description": "Lists Bgp Peers.", + "isasync": false, + "name": "listBgpPeers", + "params": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the domain ID which the Bgp Peer is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "project who which the Bgp Peer is dedicated to", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "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": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "UUID of the Bgp Peer.", + "length": 255, + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", + "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": "UUID of zone to which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "releaseBgpPeer", + "response": [ { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "AS number of bgp peer", + "name": "asnumber", "type": "long" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -97608,269 +99625,235 @@ "type": "integer" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", + "description": "additional key/value details of the bgp peer", + "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 state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "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": "pod name of the volume", - "name": "podname", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "adds a baremetal dhcp server", + "description": "Creates an instant snapshot of a volume from existing vm snapshot.", "isasync": true, - "name": "addBaremetalDhcp", + "name": "createSnapshotFromVMSnapshot", "params": [ { - "description": "URL of the external dhcp appliance.", + "description": "the name of the snapshot", "length": 255, - "name": "url", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "The ID of the VM snapshot", "length": 255, - "name": "username", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Type of dhcp device", + "description": "The ID of the disk volume", "length": 255, - "name": "dhcpservertype", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, + "type": "uuid" + } + ], + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "response": [ + { + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "Credentials to reach external dhcp device", - "length": 255, - "name": "password", - "required": true, + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" - } - ], - "related": "listBaremetalDhcp", - "response": [ + }, { - "description": "device id of ", - "name": "id", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "url", - "name": "url", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the 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": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, - {} - ] - }, - { - "description": "Copies a snapshot from one zone to another.", - "isasync": true, - "name": "copySnapshot", - "params": [ { - "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,listZones,listZones", - "required": false, - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", - "length": 255, - "name": "sourcezoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "The ID of the zone the snapshot is being copied to.", - "length": 255, - "name": "destzoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the snapshot.", - "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "related": "revertSnapshot,listSnapshots", - "response": [ + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, { "description": "the domain ID of the snapshot's account", "name": "domainid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { @@ -97879,59 +99862,65 @@ "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", "type": "string" }, - {}, { "description": "id of the os on volume", "name": "ostypeid", "type": "string" }, + {}, + {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -97940,665 +99929,848 @@ "type": "state" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" - }, + } + ], + "since": "4.10.0" + }, + { + "description": "Lists objects at specified path on an image store.", + "isasync": false, + "name": "listImageStoreObjects", + "params": [ { - "description": "name of the snapshot", - "name": "name", + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "Template Name associated with the data store object.", + "name": "templatename", "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": "ID of the snapshot", - "name": "id", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, + {}, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Is it a directory.", + "name": "isdirectory", "type": "boolean" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", + "description": "Last modified date of the file/directory.", + "name": "lastupdated", "type": "date" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" + }, + {}, + { + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" } ], "since": "4.19.0" }, { - "description": "Adds Traffic Monitor Host for Direct Network Usage", + "description": "Dedicates a guest vlan range to an account", "isasync": false, - "name": "addTrafficMonitor", + "name": "dedicateGuestVlanRange", "params": [ { - "description": "Traffic going into the listed zones will be metered", + "description": "physical network ID of the vlan", "length": 255, - "name": "includezones", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Traffic going into the listed zones will not be metered", + "description": "project who will own the VLAN", "length": 255, - "name": "excludezones", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "URL of the traffic monitor Host", + "description": "guest vlan range to be dedicated", "length": 255, - "name": "url", + "name": "vlanrange", "required": true, "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "account who will own the VLAN", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" } ], "related": "", "response": [ { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "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 guest VLAN range", + "name": "guestvlanrange", "type": "string" }, - {}, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" } ] }, { - "description": "Updates a project", - "isasync": true, - "name": "updateProject", + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", "params": [ { - "description": "display text of the project", + "description": "the format for the image", "length": 255, - "name": "displaytext", + "name": "format", "required": false, "type": "string" }, { - "description": "id of the project to be modified", + "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 arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the image file", "length": 255, "name": "id", - "related": "activateProject,suspendProject,updateProject", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, { - "description": "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", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "swapowner", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "the name of the image file", "length": 255, - "name": "roletype", + "name": "name", "required": false, "type": "string" }, { - "description": "new Admin account for the project", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "account", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "name of the project", - "length": 255, - "name": "name", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "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": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" } ], - "related": "activateProject,suspendProject", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "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 name", + "name": "name", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the domain name where the project belongs to", + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the list of resource tags associated with vm", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "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 public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a counter for VM auto scaling", + "isasync": true, + "name": "deleteCounter", + "params": [ { - "description": "the total volume available for this project", - "name": "volumeavailable", + "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 date this project was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "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 project", - "name": "cpuavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Issues a client certificate using configured or provided CA plugin", + "isasync": true, + "name": "issueCertificate", + "params": [ { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "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": "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 memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + } + ], + "related": "listCaCertificate", + "response": [ { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, - {}, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "The client certificate", + "name": "certificate", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" } ], - "since": "3.0.0" + "since": "4.11.0" }, { - "description": "Lists internal load balancers", - "isasync": false, - "name": "listLoadBalancers", + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", "params": [ { - "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": "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": "listall", + "name": "openfirewall", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "activateProject,suspendProject", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "the ID of the load balancer", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", - "required": false, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", - "length": 255, - "name": "scheme", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the starting port of port forwarding rule's public port range", "length": 255, - "name": "pagesize", - "required": false, + "name": "publicport", + "required": true, "type": "integer" }, { - "description": "the name of the load balancer", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the source IP address of the load balancer", - "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, "name": "fordisplay", "required": false, @@ -98606,161 +100778,122 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "keyword", + "name": "vmguestip", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the network ID of the source IP address", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "publicendport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the network ID of the load balancer", + "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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "cidrlist", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "page", + "name": "privateendport", "required": false, "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the starting port of port forwarding rule's private port range", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "privateport", + "required": true, + "type": "integer" } ], - "related": "createLoadBalancer", + "related": "updatePortForwardingRule", "response": [ { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "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": "Load Balancer network id", + "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, + {}, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the 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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -98769,683 +100902,602 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "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": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the Load Balancer ID", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" - }, - {} - ], - "since": "4.2.0" + } + ] }, { - "description": "Lists user accounts", - "isasync": false, - "name": "listUsers", + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", "params": [ { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "the ID of the zone", "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the containing domain", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "List user by ID.", - "length": 255, + "description": "the ID of the dedicated resource", "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 domain ID to which the Zone is dedicated", + "name": "domainid", + "type": "string" }, + {}, { - "description": "List user by the username", - "length": 255, - "name": "username", - "required": false, + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "flag to display the resource icon for users", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", + "params": [ + { + "description": "template ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "List users by state of the user account.", + "description": "zone ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "state", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "createUser,disableUser,enableUser,getUser", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the account name of the user", + "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, + {}, { - "description": "the user firstname", - "name": "firstname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the domain ID of the user", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the type of the role", - "name": "roletype", + "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 processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, + {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the project id of the template", + "name": "projectid", "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - } - ] - }, - { - "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", - "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 secret key of the registered user", - "name": "secretkey", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a load balancer stickiness policy.", - "isasync": true, - "name": "deleteLBStickinessPolicy", - "params": [ - { - "description": "the ID of the LB stickiness policy", - "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates a VLAN IP range.", - "isasync": false, - "name": "updateVlanIpRange", - "params": [ - { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, - { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, - "type": "string" - }, - { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" - }, - { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", - "length": 255, - "name": "startip", - "required": false, + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the IPv6 network", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" - } - ], - "related": "dedicatePublicIpRange", - "response": [ - { - "description": "the network id of vlan range", - "name": "networkid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "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": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "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 OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the template ID", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" - }, - { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" } - ], - "since": "4.16.0" + ] }, { - "description": "Lists site to site vpn connection gateways", + "description": "Lists all Buckets.", "isasync": false, - "name": "listVpnConnections", + "name": "listBuckets", "params": [ { - "description": "List by keyword", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "keyword", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "string" + "type": "list" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "id of the vpn connection", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -99454,798 +101506,930 @@ "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 ID of the bucket", "length": 255, - "name": "listall", + "name": "id", + "related": "listBuckets", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "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": "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" } ], - "related": "createVpnConnection", + "related": "", "response": [ { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Bucket Quota in GB", + "name": "quota", + "type": "integer" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { - "description": "the project id", + "description": "the project id of the bucket", "name": "projectid", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the project name", - "name": "project", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Total size of objects in Bucket", + "name": "size", "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, - { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, - {}, { - "description": "the owner", - "name": "account", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "the domain name of the owner", + "description": "the domain associated with the bucket", "name": "domain", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "state", - "type": "string" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ] - }, - { - "description": "Lists resource limits.", - "isasync": false, - "name": "listResourceLimits", - "params": [ - { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", - "type": "string" - }, - { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the ID of the domain associated with the bucket", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "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": "Lists resource limits by ID.", - "length": 255, - "name": "id", - "required": false, - "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": "Bucket Encryption", + "name": "encryption", "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, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetypename", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ {}, { - "description": "the account of the resource limit", - "name": "account", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, + {}, { - "description": "the project name of the resource limit", - "name": "project", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "Object storage provider", + "name": "provider", "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 Bucket", + "name": "name", "type": "string" }, - {}, { - "description": "path of the domain to which the resource limit belongs", + "description": "path of the domain to which the bucket belongs", "name": "domainpath", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" - }, - { - "description": "the 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": "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Disables a user account", + "description": "Stops an Internal LB vm.", "isasync": true, - "name": "disableUser", + "name": "stopInternalLoadBalancerVM", "params": [ { - "description": "Disables user by user ID.", + "description": "the ID of the internal lb vm", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser", + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, "type": "uuid" + }, + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], - "related": "createUser,enableUser,getUser", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "the user ID", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the template ID for the router", + "name": "templateid", "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", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the user email address", - "name": "email", + "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", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, - {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" - } - ] - }, - { - "description": "Lists all available ISO files.", - "isasync": false, - "name": "listIsos", - "params": [ - { - "description": "true if this ISO is ready to be deployed", - "length": 255, - "name": "isready", - "required": false, - "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", - "type": "uuid" - }, - { - "description": "If set to true, list only unique isos across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", - "type": "boolean" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. 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": "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, + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the public netmask for the router", + "name": "publicnetmask", + "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": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "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 Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 traffic type of the nic", + "name": "traffictype", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "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 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": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "flag to display the resource image for the isos", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "list ISO by ID", - "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "show removed ISOs as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "list all ISOs by name", - "length": 255, - "name": "name", - "required": false, + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the date and time the router 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 state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the template name for the router", + "name": "templatename", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the account name to which the template belongs", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "The new name of the security group.", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The ID of the security group.", + "length": 255, + "name": "id", + "related": "updateSecurityGroup", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, + {}, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated", + "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 list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -100254,8 +102438,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -100264,8 +102458,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -100274,72 +102468,225 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the account associated with the tag", + "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": "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": "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 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 protocol of the security group rule", + "name": "protocol", + "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 domain associated with the tag", - "name": "domainid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ + { + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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": "the tag of this template", - "name": "templatetag", + "description": "Domain UUID, required for adding domain from another Region", + "length": 255, + "name": "domainid", + "required": false, + "type": "string" + } + ], + "related": "listDomains,listDomains", + "response": [ + { + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", "type": "string" }, { @@ -100347,348 +102694,409 @@ "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the status of the template", - "name": "status", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "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 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": "the template name", - "name": "name", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" - } - ] - }, - { - "description": "Migrate current NFS secondary storages to use object store.", - "isasync": false, - "name": "updateCloudToUseObjectStore", - "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 total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the URL for the image store", - "length": 255, - "name": "url", - "required": false, + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" - } - ], - "related": "listSwifts,addImageStoreS3,listImageStores", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the level of the domain", + "name": "level", "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the name of the image store", + "description": "the name of the domain", "name": "name", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" } - ], - "since": "4.3.0" + ] }, { - "description": "Lists autoscale policies.", + "description": "Adds backup image store.", "isasync": false, - "name": "listAutoScalePolicies", + "name": "addImageStore", "params": [ { - "description": "the name of the autoscale policy", + "description": "the name for the image store", "length": 255, "name": "name", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the ID of the condition of the policy", - "length": 255, - "name": "conditionid", - "related": "", + "description": "the URL for the image store", + "length": 2048, + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the autoscale vm group", + "description": "the image store provider name", "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" + "name": "provider", + "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 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": "isrecursive", + "name": "details", "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.", + "description": "the Zone ID for the image store", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" + } + ], + "related": "addSecondaryStorage,listSwifts", + "response": [ + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "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": "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 action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": false, + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the provider name of the image store", + "name": "providername", + "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) zone to revoke certificate", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "id of the certificate", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listTemplateDirectDownloadCertificates", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the autoscale policy", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "(optional) hypervisor type", "length": 255, - "name": "account", + "name": "hypervisor", "required": false, "type": "string" } ], - "related": "", + "related": "provisionTemplateDirectDownloadCertificate", "response": [ { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, + {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -100696,468 +103104,556 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "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 storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "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", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "name of the autoscale policy", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the name of the storage pool", "name": "name", "type": "string" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, - {}, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" - } - ] - }, - { - "description": "Dedicates an existing IPv4 subnet for a zone to an account or a domain.", - "isasync": true, - "name": "dedicateIpv4SubnetForZone", - "params": [ + }, { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "domain ID of the account owning the IPv4 subnet", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "Id of the guest network IPv4 subnet", - "length": 255, - "name": "id", - "related": "dedicateIpv4SubnetForZone", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, + {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, + {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" } ], - "since": "4.20.0" + "since": "4.16.0" }, { - "description": "Creates a range of Autonomous Systems for BGP Dynamic Routing", + "description": "Changes ownership of a Volume from one account to another.", "isasync": false, - "name": "createASNRange", + "name": "assignVolume", "params": [ { - "description": "the end AS Number", + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", "length": 255, - "name": "endasn", - "required": true, - "type": "long" + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the start AS Number", + "description": "The ID of the volume to be reassigned.", "length": 255, - "name": "startasn", + "name": "volumeid", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", "required": true, - "type": "long" + "type": "uuid" }, { - "description": "the zone ID", + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" } ], - "related": "listASNRanges", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "ID of the AS Number Range", - "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": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "Start AS Number", - "name": "startasn", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "Created date", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "End AS Number", - "name": "endasn", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "List Shared FileSystems", - "isasync": false, - "name": "listSharedFileSystems", - "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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "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": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the disk offering of the shared filesystem", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "type": "uuid" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the service offering of the shared filesystem", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "description": "the bytes actually consumed on disk", + "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": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the name of the shared filesystem", - "length": 255, + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "name of the disk volume", "name": "name", - "required": false, "type": "string" }, { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the availability zone", - "length": 255, + "description": "ID of the availability zone", "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "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 ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", - "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "changeSharedFileSystemDiskOffering", - "response": [ + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "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": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -101166,1415 +103662,1358 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "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": "Network ID of the shared filesystem", - "name": "networkid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, {}, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + } + ], + "since": "4.18.0.0" + }, + { + "description": "Deletes a userdata", + "isasync": false, + "name": "deleteUserData", + "params": [ + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "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" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.18" + }, + { + "description": "Lists all network services provided by CloudStack or for the given Provider.", + "isasync": false, + "name": "listSupportedNetworkServices", + "params": [ + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "network service provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", + "description": "the service provider name", + "name": "provider", "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": "the ip address of the nic", - "name": "ipaddress", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the 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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "uuid of the network provider", + "name": "id", "type": "string" } ], "type": "list" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" } ], - "since": "4.20.0" + "since": "3.0.0" }, { - "description": "adds baremetal rack configuration text", + "description": "Deletes a particular ingress rule from this security group", "isasync": true, - "name": "addBaremetalRct", + "name": "revokeSecurityGroupIngress", "params": [ { - "description": "http url to baremetal RCT configuration", + "description": "The ID of the ingress rule", "length": 255, - "name": "baremetalrcturl", + "name": "id", + "related": "authorizeSecurityGroupIngress", "required": true, - "type": "object" + "type": "uuid" } ], - "related": "", "response": [ + {}, { - "description": "id of rct", - "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 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": "url", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { - "description": "Updates a role", - "isasync": false, - "name": "updateRole", + "description": "Adds a network serviceProvider to a physical network", + "isasync": true, + "name": "addNetworkServiceProvider", "params": [ { - "description": "creates a role with this unique name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "The description of the role", + "description": "the destination Physical Network ID to bridge to", "length": 255, - "name": "description", + "name": "destinationphysicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "the Physical Network ID to add the provider to", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "The description of the role", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "description", + "name": "servicelist", "required": false, - "type": "string" + "type": "list" }, { - "description": "ID of the role", + "description": "the name for the physical network service provider", "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", + "name": "name", "required": true, - "type": "uuid" - }, - { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, "type": "string" } ], - "related": "importRole,listRoles", + "related": "listTrafficTypes", "response": [ { - "description": "the name of the role", + "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": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, - {}, { - "description": "the ID of the role", + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", "name": "id", "type": "string" }, + {}, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the state of the role", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ] + }, + { + "description": "Marks a quota tariff as removed.", + "isasync": false, + "name": "quotaTariffDelete", + "params": [ { - "description": "the description of the role", - "name": "description", + "description": "ID of the quota tariff", + "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 type of the role", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.9.0" + "since": "4.18.0.0" }, { - "description": "Lists zones", + "description": "Creates a service offering.", "isasync": false, - "name": "listZones", + "name": "createServiceOffering", "params": [ { - "description": "List by keyword", + "description": "max iops of the compute offering", "length": 255, - "name": "keyword", + "name": "maxiops", "required": false, - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "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": "networktype", + "name": "isvolatile", + "required": false, + "type": "boolean" + }, + { + "description": "The display text of the service offering, defaults to 'name'.", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "page", + "name": "networkrate", "required": false, "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "length (in seconds) of the burst", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "bytesreadratemaxlength", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "pagesize", + "name": "serviceofferingdetails", "required": false, - "type": "integer" + "type": "map" }, { - "description": "flag to display the resource image for the zones", + "description": "length (in seconds) of the burst", "length": 255, - "name": "showicon", + "name": "byteswriteratemaxlength", "required": false, - "type": "boolean" + "type": "long" }, { - "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": "whether compute offering iops is custom or not", "length": 255, - "name": "available", + "name": "customizediops", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the name of the zone", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "name", + "name": "mincpunumber", "required": false, - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "flag to display the capacity of the zones", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "showcapacities", + "name": "limitcpuuse", "required": false, "type": "boolean" }, { - "description": "the ID of the zone", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "provisioningtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", + "name": "maxmemory", "required": false, - "since": "4.19.0", - "type": "list" + "since": "4.13", + "type": "integer" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "length (in seconds) of the burst", "length": 255, - "name": "tags", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.3", - "type": "map" - } - ], - "related": "createZone,listZones", - "response": [ - { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "type": "long" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, "type": "integer" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the list of resource tags associated with zone.", - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "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" - } - ], - "type": "set" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the CPU number of the service offering", + "length": 255, + "name": "cpunumber", + "required": false, + "type": "integer" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "length": 255, + "name": "cpuspeed", + "required": false, + "type": "integer" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "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": "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 should be mapped", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "Whether service offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "Zone description", - "name": "description", + "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 local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "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": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "the HA for the service offering", + "length": 255, + "name": "offerha", + "required": false, "type": "boolean" }, - {}, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "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 percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - } - ], - "type": "list" + "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 name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "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", + "length": 255, + "name": "diskofferingstrictness", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "VMs using this offering require root volume encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "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": "Zone name", + "description": "the name of the service offering", + "length": 255, "name": "name", + "required": true, "type": "string" - } - ] - }, - { - "description": "Lists remote access vpns", - "isasync": false, - "name": "listRemoteAccessVpns", - "params": [ + }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "account", + "name": "iopsreadratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "", + "description": "is this a system vm offering", "length": 255, - "name": "page", + "name": "issystem", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "pagesize", + "name": "maxcpunumber", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "public ip address id of the vpn server", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "bytesreadrate", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "List by keyword", + "description": "length (in seconds) of the burst", "length": 255, - "name": "keyword", + "name": "iopswriteratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "systemvmtype", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "list remote access VPNs for certain network", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.4", + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "listDomains,listDomains", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "isrecursive", + "name": "storagepolicy", + "related": "", "required": false, - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "bytesreadratemax", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "fordisplay", + "name": "iopswriterate", "required": false, - "since": "4.4", - "type": "boolean" + "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 storage type of the service offering. Values are local and shared.", "length": 255, - "name": "listall", + "name": "storagetype", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "updateRemoteAccessVpn", + "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the name of the service offering", + "name": "name", "type": "string" }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "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 state of the rule", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "state of the service offering", "name": "state", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "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 public ip address of the vpn server", - "name": "publicip", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" - } - ] - }, - { - "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", - "isasync": false, - "name": "removeQuarantinedIp", - "params": [ + }, { - "description": "The reason for removing the public IP address from quarantine prematurely.", - "length": 255, - "name": "removalreason", - "required": true, - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", - "required": false, - "type": "uuid" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" - } - ], - "related": "listQuarantinedIps,updateQuarantinedIp", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, + {}, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the memory in MB", + "name": "memory", + "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": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, - {}, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, - {} - ], - "since": "4.19" - }, - { - "description": "Deletes a Webhook", - "isasync": false, - "name": "deleteWebhook", - "params": [ { - "description": "The ID of the Webhook", - "length": 255, - "name": "id", - "related": "createWebhook,listWebhookDeliveries", - "required": true, - "type": "uuid" - } - ], - "response": [ + "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 id of the service offering", + "name": "id", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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" - } - ], - "since": "4.20.0" - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACLList", - "params": [ { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Removes secondary IP from the NIC.", - "isasync": true, - "name": "removeIpFromNic", - "params": [ + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, { - "description": "the ID of the secondary ip address to nic", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, - {} - ] - }, - { - "description": "Releases a Public IP range back to the system pool", - "isasync": false, - "name": "releasePublicIpRange", - "params": [ - { - "description": "the id of the Public IP range", - "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, - {}, { - "description": "any text associated with the success or failure", + "description": "an alternate display text of the service offering.", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" } ] }, { - "description": "lists network that are using a netscaler load balancer device", + "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": "listNetscalerLoadBalancerNetworks", + "name": "assignVirtualMachine", "params": [ { - "description": "", + "description": "id of the VM to be moved", "length": 255, - "name": "pagesize", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", + "description": "an optional project for the new VM owner.", "length": 255, - "name": "page", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "netscaler load balancer device ID", + "description": "domain id of the new VM owner.", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "required": true, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", "required": false, "type": "string" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + {}, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -102583,13 +105022,13 @@ "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" }, { @@ -102598,202 +105037,97 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - { - "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "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": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", "type": "set" }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, {}, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -102801,768 +105135,1274 @@ "name": "icon", "type": "resourceiconresponse" }, - {}, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "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": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the provider name", - "name": "name", + "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": "list" + "type": "set" }, { - "description": "the service name", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the 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": "tag value", + "name": "value", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", + "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 id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the capability name", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the capability value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, + {}, { - "description": "the type of the network", - "name": "type", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - } - ] - }, - { - "description": "Starts a system virtual machine.", - "isasync": true, - "name": "startSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "migrateSystemVm,startSystemVm", - "required": true, - "type": "uuid" - } - ], - "related": "migrateSystemVm", - "response": [ - { - "description": "the date and time the system VM was created", + "description": "the date when this virtual machine 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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - {}, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the Pod name for the system VM", - "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": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the 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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + } + ], + "type": "set" }, { - "description": "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 Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "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" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists supported methods of network isolation", + "description": "Lists virtual machines on a unmanaged host", "isasync": false, - "name": "listNetworkIsolationMethods", + "name": "listVmsForImport", "params": [ { - "description": "", + "description": "hypervisor type of the host", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "the username for the host", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Network isolation method name", - "name": "name", "type": "string" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Registers an existing VNF template into the CloudStack cloud. ", - "isasync": false, - "name": "registerVnfTemplate", - "params": [ { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the zone ID", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "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": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "", "length": 255, - "name": "vnfdetails", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "the host name or IP address", "length": 255, - "name": "vnfnics", - "required": false, - "type": "map" + "name": "host", + "required": true, + "type": "string" }, { - "description": "the tag for this template.", + "description": "the password for the host", "length": 255, - "name": "templatetag", + "name": "password", "required": false, "type": "string" - }, + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "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 controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + } + ], + "type": "set" }, { - "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, + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" }, { - "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 list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" }, { - "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": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, { - "description": "the ID of the zone the template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, + {}, + {}, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "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": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", - "required": false, + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { - "description": "the name of the template", - "length": 255, + "description": "the name of the virtual machine", "name": "name", - "required": true, "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "configures a netscaler load balancer device", + "isasync": true, + "name": "configureNetscalerLoadBalancer", + "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "isrouting", + "name": "lbdevicecapacity", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "lbdevicededicated", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "Register template for the project", + "description": "Netscaler load balancer device ID", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "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": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "name": "podids", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "list" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "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": "directdownload", + "name": "inline", "required": false, "type": "boolean" } ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, + {}, + {}, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the status of the template", - "name": "status", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -103570,382 +106410,344 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, - {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "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": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "name of the provider", + "name": "provider", + "type": "string" + } + ] + }, + { + "description": "delete Tungsten-Fabric service group", + "isasync": true, + "name": "deleteTungstenFabricServiceGroup", + "params": [ + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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 date this template was removed", - "name": "removed", - "type": "date" + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the template name", + "description": "the name for the object store", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", + "description": "the object store provider name", + "length": 255, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, + "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" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the template display text", - "name": "displaytext", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the provider name of the object store", + "name": "providername", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the object store", + "name": "name", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, + "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": "CPU Arch of the template", - "name": "arch", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" } ], - "since": "4.19.0" + "since": "4.15.0" }, { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", + "description": "Deletes a Network Service Provider.", + "isasync": true, + "name": "deleteNetworkServiceProvider", "params": [ { - "description": "List by host ID", + "description": "the ID of the network service provider", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", - "required": false, + "name": "id", + "related": "listTrafficTypes", + "required": true, "type": "uuid" } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "the host HA provider", - "name": "haprovider", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { "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": "if host HA is enabled for the host", - "name": "haenable", + "description": "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 HA state of the host", - "name": "hastate", - "type": "hastate" } ], - "since": "4.11" + "since": "3.0.0" }, { - "description": "Lists VM stats", + "description": "List network devices", "isasync": false, - "name": "listVirtualMachinesUsageHistory", + "name": "listNetworkDevice", "params": [ { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "List by keyword", "length": 255, - "name": "startdate", + "name": "keyword", "required": false, - "type": "date" + "type": "string" }, { - "description": "List by keyword", + "description": "parameters for network device", "length": 255, - "name": "keyword", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "name", + "name": "networkdevicetype", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the virtual machine.", + "description": "", "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addNetworkDevice", + "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 network device", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "type": "string" + } + ] + }, + { + "description": "Lists Project roles in CloudStack", + "isasync": false, + "name": "listProjectRoles", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "", @@ -103955,32 +106757,45 @@ "type": "integer" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "List project role by project role name.", "length": 255, - "name": "enddate", + "name": "name", "required": false, - "type": "date" + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id.", + "description": "List project role by project 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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "List project role by project role ID.", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "list" + "type": "uuid" } ], - "related": "listSystemVmsUsageHistory", + "related": "updateProjectRole", "response": [ { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the description of the role", + "name": "description", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "id", "type": "string" }, { @@ -103989,822 +106804,1094 @@ "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ], - "since": "4.17" + "since": "4.15.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.", + "description": "Removes an OpenDyalight controler", "isasync": true, - "name": "declareHostAsDegraded", + "name": "deleteOpenDaylightController", "params": [ { - "description": "host ID", + "description": "OpenDaylight Controller ID", "length": 255, "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "related": "deleteOpenDaylightController", "required": true, "type": "uuid" } ], - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "related": "", "response": [ { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "device id of the controller", + "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 to which this controller belongs to", + "name": "physicalnetworkid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the username to authenticate to the controller", + "name": "username", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Updates attributes of a template.", + "isasync": false, + "name": "updateTemplate", + "params": [ + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "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": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, + "type": "uuid" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "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": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "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 Zone ID of the host", - "name": "zoneid", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, + {}, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum 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": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 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": "list" + "type": "set" }, + {}, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "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 admin that annotated this host", - "name": "username", + "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 amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the host", - "name": "name", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the ID of the host", - "name": "id", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the date and time the host was removed", + "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": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" } - ], - "since": "4.16.0.0" + ] }, { - "description": "List a storage network IP range.", + "description": "Creates a VLAN IP range.", "isasync": false, - "name": "listStorageNetworkIpRange", + "name": "createVlanIpRange", "params": [ { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "the network id", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "uuid" }, { - "description": "", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "keyword", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" - } - ], - "related": "createStorageNetworkIpRange", - "response": [ - { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "type": "boolean" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, "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 gateway of the storage network IP range", - "name": "gateway", + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "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 start ip of the storage network IP range", - "name": "startip", + "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" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a specified domain", - "isasync": true, - "name": "deleteDomain", - "params": [ + }, { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "cleanup", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "ID of domain to delete", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": true, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, "type": "uuid" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" } ], + "related": "updateVlanIpRange", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" - } - ] - }, - { - "description": "Configures a virtual router element.", - "isasync": true, - "name": "configureVirtualRouterElement", - "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" }, { - "description": "the ID of the virtual router provider", - "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "required": true, - "type": "uuid" - } - ], - "related": "listVirtualRouterElements", - "response": [ + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, { - "description": "the project id of the ipaddress", + "description": "the project id of the vlan range", "name": "projectid", "type": "string" }, - {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the address", + "description": "the project name of the vlan range", "name": "project", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, {}, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" + }, + {}, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" } ] }, { - "description": "Enables HA for a host", + "description": "Updates site to site vpn connection", "isasync": true, - "name": "enableHAForHost", + "name": "updateVpnConnection", "params": [ { - "description": "ID of the host", + "description": "id of vpn connection", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "id", + "related": "updateVpnConnection", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "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": "configureHAForHost,disableHAForHost,listHostHAProviders", + "related": "", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "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": "operation status", - "name": "status", + "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": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - } + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the 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 customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + {}, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + {} ], - "since": "4.11" + "since": "4.4" }, { - "description": "Migrate volume", - "isasync": true, - "name": "migrateVolume", + "description": "lists network that are using Palo Alto firewall device", + "isasync": false, + "name": "listPaloAltoFirewallNetworks", "params": [ { - "description": "the ID of the volume", + "description": "List by keyword", "length": 255, - "name": "volumeid", - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "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.", + "description": "palo alto balancer device ID", "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, + "name": "lbdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, "type": "uuid" }, { - "description": "if the volume should be live migrated when it is attached to a running vm", + "description": "", "length": 255, - "name": "livemigrate", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "destination storage pool ID to migrate the volume to", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -104813,8 +107900,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104823,23 +107910,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -104848,434 +107935,621 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "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 disk utilization", - "name": "utilization", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the project id of the ipaddress", + "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": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the owner of the network", + "name": "account", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "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": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - {}, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "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": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Deletes an existing Bgp Peer.", - "isasync": true, - "name": "deleteBgpPeer", + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", "params": [ { - "description": "Id of the Bgp Peer", + "description": "CloudStack Volume UUID", "length": 255, - "name": "id", - "related": "updateBgpPeer", + "name": "volumeid", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "", "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "A command to list events.", + "description": "Lists management servers.", "isasync": false, - "name": "listEvents", + "name": "listManagementServers", "params": [ { - "description": "the ID of the event", + "description": "the id of the management server", "length": 255, "name": "id", - "related": "listEvents", + "related": "listManagementServers", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "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": "", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "List by keyword", "length": 255, - "name": "startdate", + "name": "keyword", "required": false, - "type": "date" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the name of the management server", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "name", "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": "the duration of the event", - "length": 255, - "name": "duration", - "required": false, + "description": "the ID of the management server", + "name": "id", + "type": "string" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + }, + { + "description": "the IP Address for this Management Server", + "name": "serviceip", + "type": "string" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the event type (see event types)", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + {}, + { + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + {}, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + } + ] + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicyRule", + "params": [ + { + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -105285,11 +108559,10 @@ "type": "string" }, { - "description": "the type of the resource associated with the event", + "description": "the uuid of Tungsten-Fabric rule", "length": 255, - "name": "resourcetype", + "name": "ruleuuid", "required": false, - "since": "4.17.0", "type": "string" }, { @@ -105300,756 +108573,683 @@ "type": "integer" }, { - "description": "the ID of the resource associated with the event", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "true to list archived events otherwise false", + "description": "the ID of zone", "length": 255, - "name": "archived", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" + } + ], + "related": "addTungstenFabricPolicyRule", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "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": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "direction", + "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": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {} + ] + }, + { + "description": "delete Tungsten-Fabric policy", + "isasync": true, + "name": "deleteTungstenFabricPolicy", + "params": [ + { + "description": "the Uuid of Tungsten-Fabric tag type", "length": 255, - "name": "level", - "required": false, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "the time the event was entered", + "description": "the ID of zone", "length": 255, - "name": "entrytime", - "required": false, + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ + { + "description": "new instance group name", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "updateInstanceGroup", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "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)", + "description": "the account owning the instance group", "name": "account", "type": "string" }, { - "description": "the project id of the ipaddress", + "description": "the project ID of the instance group", "name": "projectid", "type": "string" }, { - "description": "the id of the resource", - "name": "resourceid", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, - {}, { - "description": "whether the event is parented", - "name": "parentid", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the instance group", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "List the uploaded certificates for direct download templates", + "isasync": false, + "name": "listTemplateDirectDownloadCertificates", + "params": [ { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "if set to true: include the hosts where the certificate is uploaded to", + "length": 255, + "name": "listhosts", + "required": false, + "type": "boolean" }, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the type of the resource", - "name": "resourcetype", - "type": "string" + "description": "the zone where certificates are uploaded", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, {}, { - "description": "a brief description of the event", - "name": "description", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" } - ] + ], + "since": "4.17.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.", - "isasync": true, - "name": "updateVMAffinityGroup", + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", "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": "", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "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": "the ID of the ucs manager", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "id", + "related": "listUcsManagers", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the ucs manager", + "name": "id", + "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 name of ucs manager", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + {} + ] + }, + { + "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": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "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": "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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 project name of the vm", - "name": "project", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "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 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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -106058,44 +109258,54 @@ "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": "Type of adapter if available", - "name": "adaptertype", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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": "true if nic is default, false otherwise", @@ -106103,43 +109313,43 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -106148,18 +109358,13 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ip address of the nic", + "name": "ipaddress", "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" }, { @@ -106167,717 +109372,697 @@ "name": "mtu", "type": "integer" }, - { - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "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 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "the 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 host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the Zone name for the router", + "name": "zonename", + "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": "OS name of the vm", - "name": "osdisplayname", + "description": "the public IP address for the router", + "name": "publicip", "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": "Base64 string containing the user data", - "name": "userdata", + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "type": "uuid" + }, + { + "description": "The path of the volume", + "length": 255, + "name": "path", + "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": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "new name of the volume", + "length": 255, + "name": "name", + "required": false, + "since": "4.16", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "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", + "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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": "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": "importVolume,createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "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": "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "User VM type", + "description": "type of the virtual machine", "name": "vmtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "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": "ssh key-pairs", - "name": "keypairs", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ + }, { - "description": "Hypervisor type of the resource", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "configureHAForHost,disableHAForHost", - "response": [ + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the ID of the host", - "name": "hostid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, - {}, - {} - ], - "since": "4.11" - }, - { - "description": "Registers NCC Service Package", - "isasync": false, - "name": "registerNetscalerServicePackage", - "params": [ { - "description": "Name of the service Package.", - "length": 255, - "name": "name", - "required": true, + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Description of Service Package", - "length": 255, - "name": "description", - "required": true, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" - } - ], - "related": "listRegisteredServicePackages", - "response": [ + }, { - "description": "Description of Service Package", - "name": "description", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "Service Package Name", - "name": "name", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { - "description": "Service Package UUID", - "name": "id", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Updates a Webhook", - "isasync": false, - "name": "updateWebhook", - "params": [ + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { - "description": "Secret key of the Webhook", - "length": 255, - "name": "secretkey", - "required": false, - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Description for the Webhook", - "length": 255, - "name": "description", - "required": false, + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "Name for the Webhook", - "length": 255, - "name": "name", - "required": false, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", - "length": 255, - "name": "sslverification", - "required": false, + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "Payload URL of the Webhook", - "length": 255, - "name": "payloadurl", - "required": false, + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "Scope of the Webhook", - "length": 255, - "name": "scope", - "required": false, + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "The ID of the Webhook", - "length": 255, - "name": "id", - "related": "createWebhook,listWebhookDeliveries", - "required": true, - "type": "uuid" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "State of the Webhook", - "length": 255, - "name": "state", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "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" - } - ], - "since": "4.20.0" - }, - { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", - "params": [ + }, { - "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 format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "Map of tags (key/value pairs)", - "length": 255, + "description": "the list of resource tags associated", "name": "tags", - "required": true, - "type": "map" + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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": "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": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "list of resources to create the tags for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" } - ], - "since": "4.0.0" + ] }, { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "description": "Lists traffic types of a given physical network.", "isasync": false, - "name": "listCaCertificate", + "name": "listTrafficTypes", "params": [ { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "the Physical Network ID", "length": 255, - "name": "provider", + "name": "physicalnetworkid", + "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": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, {}, - { - "description": "The CA certificate(s)", - "name": "cacertificates", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -106885,495 +110070,571 @@ "type": "integer" }, { - "description": "The client certificate", - "name": "certificate", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "Private key for the certificate", - "name": "privatekey", - "type": "string" - } - ], - "since": "4.11.0" - }, - { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", - "params": [ - { - "description": "the network service provider ID of the internal load balancer element", - "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, - "type": "uuid" - } - ], - "related": "configureInternalLoadBalancerElement", - "response": [ - {}, - { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "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 id of the internal load balancer element", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", "name": "id", "type": "string" } ], - "since": "4.2.0" + "since": "3.0.0" }, { - "description": "Reset api count", + "description": "Updates account information for the authenticated user", "isasync": false, - "name": "resetApiLimit", + "name": "updateAccount", "params": [ { - "description": "the ID of the account whose limit to be reset", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "account", - "related": "enableAccount,listAccounts,listAccounts", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "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 latest async job acting on this object", - "name": "jobid", + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a VLAN IP range.", - "isasync": false, - "name": "deleteVlanIpRange", - "params": [ + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" + }, { - "description": "the id of the VLAN IP range", + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Account UUID", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", - "required": true, + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, "type": "uuid" } ], + "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, - {}, - {} - ] - }, - { - "description": "Provisions a host with a direct download certificate", - "isasync": false, - "name": "provisionTemplateDirectDownloadCertificate", - "params": [ { - "description": "the host to provision the certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the id of the direct download certificate to provision", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Generates an alert", - "isasync": true, - "name": "generateAlert", - "params": [ + {}, { - "description": "Zone id for which alert is generated", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "Name of the alert", - "length": 255, + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + {}, + { + "description": "the name of the account", "name": "name", - "required": true, "type": "string" }, { - "description": "Pod id for which alert is generated", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - } - ], - "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 available for this account to acquire", + "name": "vmavailable", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" - } - ], - "since": "4.3" - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "updateProjectRole", - "params": [ + }, { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "ID of the Project role", - "length": 255, - "name": "id", - "related": "updateProjectRole", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 description of the role", - "name": "description", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { "description": "the ID of the role", - "name": "id", + "name": "roleid", "type": "string" }, { "description": "the name of the role", - "name": "name", + "name": "rolename", "type": "string" - } - ], - "since": "4.15.0" - }, - { - "description": "Add a new Ldap Configuration", - "isasync": false, - "name": "addLdapConfiguration", - "params": [ + }, { - "description": "Port", - "length": 255, - "name": "port", - "required": true, - "type": "integer" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, + "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": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "linked domain", - "name": "domainid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", - "isasync": false, - "name": "ldapConfig", - "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, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389.", - "length": 255, - "name": "port", - "required": false, - "type": "integer" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "Enter the password for trust store.", - "length": 255, - "name": "truststorepass", - "required": false, + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", - "length": 255, - "name": "searchbase", - "required": false, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "Enter the password.", - "length": 255, - "name": "bindpass", - "required": false, + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", - "length": 255, - "name": "binddn", - "required": false, + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", - "length": 255, - "name": "ssl", - "required": false, + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "length": 255, - "name": "hostname", - "required": false, + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "Enter the path to trust certificates store.", - "length": 255, - "name": "truststore", - "required": false, + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "If true return current LDAP configuration", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + } + ] + }, + { + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", + "params": [ + { + "description": "the Zone ID for the secondary storage", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" } ], - "related": "ldapRemove", + "related": "listSwifts", "response": [ { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, {}, { @@ -107382,188 +110643,276 @@ "type": "integer" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "DN password", - "name": "bindpass", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a port forwarding rule", - "isasync": true, - "name": "deletePortForwardingRule", - "params": [ + }, { - "description": "the ID of the port forwarding rule", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the name of the image store", + "name": "name", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Zone ID of the image store", + "name": "zoneid", "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 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": "moves a vpc to another physical network", - "isasync": true, - "name": "migrateVPC", + "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": "the ID of the vpc", + "description": "The ID of the virtual machine", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, "type": "uuid" }, { - "description": "vpc offering ID", + "description": "list of security group ids to be applied on the virtual machine.", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "true if previous network migration cmd failed", + "description": "instance name of the user vm", "length": 255, - "name": "resume", + "name": "instancename", + "required": false, + "since": "4.4", + "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": "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": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", + "type": "string" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "tiernetworkofferings", + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", "required": false, + "since": "4.18", "type": "map" - } - ], - "related": "createVPC,listVPCs,updateVPC", - "response": [ + }, { - "description": "the project name of the VPC", - "name": "project", + "description": "user generated name", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, + { + "description": "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": "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": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "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": "zone id of the vpc", - "name": "zoneid", + "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": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated with the project", + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "type": "boolean" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "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" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -107572,26 +110921,16 @@ "type": "string" } ], - "type": "list" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "type": "set" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -107600,1390 +110939,1684 @@ "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability 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": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "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 service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "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 cidr the VPC", - "name": "cidr", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Deletes a global load balancer rule.", - "isasync": true, - "name": "deleteGlobalLoadBalancerRule", - "params": [ - { - "description": "the ID of the global load balancer rule", - "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "update an annotation visibility.", - "isasync": false, - "name": "updateAnnotationVisibility", - "params": [ - { - "description": "the annotation is visible for admins only", - "length": 255, - "name": "adminsonly", - "required": true, - "type": "boolean" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "removeAnnotation", - "response": [ - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" + "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 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "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" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + } + ], + "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 name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, - {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the 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 removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "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" - } - ], - "since": "4.16" - }, - { - "description": "Lists BigSwitch BCF Controller devices", - "isasync": false, - "name": "listBigSwitchBcfDevices", - "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + {}, { - "description": "bigswitch BCF controller device ID", - "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - {}, - { - "description": "device name", - "name": "bigswitchdevicename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the controller username", - "name": "username", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the controller password", - "name": "password", - "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" - } - ], - "since": "4.6.0" - }, - { - "description": "Updates a configuration.", - "isasync": false, - "name": "updateConfiguration", - "params": [ - { - "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "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" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "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 virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "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 Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - }, - { - "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" - } - ], - "related": "", - "response": [ - { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the value of the configuration", - "name": "id", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, + {}, { - "description": "the category of the configuration", - "name": "category", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the configuration", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ + }, { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" - } - ], - "related": "disableHAForHost", - "response": [ + }, { - "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": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", - "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "Lists volume stats", - "isasync": false, - "name": "listVolumesUsageHistory", - "params": [ - { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", - "length": 255, - "name": "name", - "required": false, - "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the 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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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 name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "migrateSystemVm", - "required": false, - "type": "list" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the volume", - "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 volume", - "name": "name", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" - }, - {} - ], - "since": "4.18.0" + } + ] }, { - "description": "Dedicates a Public IP range to an account", - "isasync": false, - "name": "dedicatePublicIpRange", + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", "params": [ { - "description": "the id of the VLAN IP range", + "description": "Disables specified account.", "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "project who will own the VLAN", + "description": "If true, only lock the account; else disable the account", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "lock", + "required": true, + "type": "boolean" }, { - "description": "account who will own the VLAN", + "description": "Disables specified account in this domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "Account id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, + "name": "id", + "related": "disableAccount,enableAccount,listAccounts", + "required": false, "type": "uuid" } ], - "related": "", + "related": "enableAccount,listAccounts", "response": [ { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "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 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 name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" - } - ] - }, - { - "description": "Deletes an empty Bucket.", - "isasync": false, - "name": "deleteBucket", - "params": [ + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds API permissions to a project role", - "isasync": false, - "name": "createProjectRolePermission", - "params": [ { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "ID of project where project role permission is to be created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + {}, { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, { - "description": "the ID of the project", - "name": "projectid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, - {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "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 secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "lists registered service packages", - "isasync": false, - "name": "listRegisteredServicePackages", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Service Package UUID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "Service Package Name", - "name": "name", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", - "type": "string" - }, - {} + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + } ] }, { - "description": "Create a console endpoint to connect to a VM console", + "description": "Lists domains and provides detailed information for listed domains", "isasync": false, - "name": "createConsoleEndpoint", + "name": "listDomains", "params": [ { - "description": "ID of the VM", + "description": "List by keyword", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "(optional) extra security token, valid when the extra validation is enabled", + "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "token", + "name": "details", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "true if the console endpoint is generated properly", - "name": "success", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the console url", - "name": "url", - "type": "string" - }, - { - "description": "details in case of an error", - "name": "details", - "type": "string" + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, - {}, - { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" - } - ], - "since": "4.18.0" - }, - { - "description": "Change Disk offering of a Shared FileSystem", - "isasync": true, - "name": "changeSharedFileSystemDiskOffering", - "params": [ { - "description": "the disk offering to use for the underlying storage", + "description": "", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the size of the shared filesystem in GiB", + "description": "List domains by domain level.", "length": 255, - "name": "size", + "name": "level", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the ID of the shared filesystem", + "description": "", "length": 255, - "name": "id", - "related": "changeSharedFileSystemDiskOffering", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "max iops", + "description": "List domain by domain ID.", "length": 255, - "name": "maxiops", + "name": "id", + "related": "listDomains,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "min iops", + "description": "List domain by domain name.", "length": 255, - "name": "miniops", + "name": "name", "required": false, - "type": "long" + "type": "string" } ], - "related": "", + "related": "listDomains", "response": [ { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "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 vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "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 total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag 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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -108991,163 +112624,639 @@ "type": "integer" }, { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, - {}, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + {}, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + } + ] + }, + { + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "isasync": false, + "name": "resetUserDataForVirtualMachine", + "params": [ + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "type": "map" + }, + { + "description": "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 project for the virtual machine", + "length": 255, + "name": "projectid", + "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": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the type of the nic", - "name": "type", + "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the security group", + "name": "name", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -109156,58 +113265,78 @@ "type": "integer" }, { - "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 IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the 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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -109216,132 +113345,156 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" } ], - "type": "list" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "type": "set" }, - {}, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Name of the availability zone", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the write (IO) of disk on the shared filesystem", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", "name": "diskiowrite", "type": "long" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "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.20.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": "ruleorder", - "related": "", - "required": false, - "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": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": true, - "type": "uuid" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "ID of project where project role permission is to be updated", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "Project Role permission rule id", - "length": 255, - "name": "projectrolepermissionid", - "related": "", - "required": false, - "type": "uuid" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -109350,250 +113503,617 @@ "type": "integer" }, { - "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" }, - {} - ], - "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)", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the public IP address ID for which static NAT feature is being enabled", - "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", - "length": 255, - "name": "vmguestip", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", - "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "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", + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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 account owning the affinity group", + "name": "account", + "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, - {} - ] - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "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": "email ID of user to which invitation to the project is going to be sent", - "length": 255, - "name": "email", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Project role type to be assigned to the user - Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "ID of the project to add the user to", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Name of the user to be added to the project", - "length": 255, - "name": "username", - "required": true, + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 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", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "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": "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 project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + {}, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, - {} + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + } ], - "since": "4.14" + "since": "4.18.0" }, { - "description": "Disables HA cluster-wide", + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "disableHAForCluster", + "name": "deleteTemplate", "params": [ { - "description": "ID of the cluster", + "description": "the ID of the template", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" + }, + { + "description": "Necessary if the template's type is system.", + "length": 255, + "name": "issystem", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Lists all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ + { + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {} - ], - "since": "4.11" - }, - { - "description": "Expunge a Shared FileSystem by id", - "isasync": true, - "name": "expungeSharedFileSystem", - "params": [ { - "description": "the ID of the shared filesystem to expunge", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": false, "type": "uuid" + }, + { + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list network ACLs by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" } ], + "related": "createNetworkACLList", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -109601,903 +114121,726 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the ACL", + "name": "id", + "type": "string" + }, + {}, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "Description of the ACL", + "name": "description", + "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "Recovers a virtual machine.", - "isasync": false, - "name": "recoverVirtualMachine", + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", "params": [ { - "description": "The ID of the virtual machine", + "description": "The ID of the snapshot", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "copySnapshot,archiveSnapshot,listSnapshots", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "copySnapshot,listSnapshots", "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "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": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, + {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", "name": "domain", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the snapshot", + "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": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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": "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": "User VM type", - "name": "vmtype", + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the vm", + "description": "the project id", "name": "projectid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ], + "since": "4.4" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the dedicated guest vlan range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the 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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "response": [ + { + "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": "true if operation 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": "Import an unmanaged volume from a storage pool on a host into CloudStack", + "isasync": true, + "name": "importVolume", + "params": [ + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "an optional account for the volume. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "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": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "import volume to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the path of the volume", + "length": 255, + "name": "path", + "required": true, "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "import volume for the project", + "length": 255, + "name": "projectid", + "related": "", + "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the VM", + "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the virtual machine", - "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": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "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": "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": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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 ID of the corresponding network", - "name": "networkid", - "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "macaddress", - "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" - } - ], - "type": "set" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the project name of the vpn", + "name": "project", "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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 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": "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { @@ -110505,8 +114848,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -110515,18 +114858,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -110535,76 +114873,91 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { @@ -110613,992 +114966,725 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", + "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": "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 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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "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": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" - } - ] - }, - { - "description": "upload an existing template into the CloudStack cloud. ", - "isasync": false, - "name": "getUploadParamsForTemplate", - "params": [ + }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "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 disk utilization", + "name": "utilization", "type": "string" }, { - "description": "Template details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "state of the virtual machine", + "name": "vmstate", + "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 date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + } + ], + "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": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "isdynamicallyscalable", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "the tag for this template.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the tag for this template.", + "description": "the zone for the template. Can be specified with snapshot only", "length": 255, - "name": "templatetag", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "since": "4.19.0", + "type": "uuid" }, { "description": "an optional accountName. Must be used with domainId.", "length": 255, "name": "account", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "deployasis", + "name": "sshkeyenabled", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "arch", + "name": "passwordenabled", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "ostypeid", + "related": "addGuestOs", "required": true, "type": "uuid" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the name of the template", "length": 255, - "name": "bits", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "listDomains", "required": false, + "since": "4.19.0", "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "create template for the project", "length": 255, - "name": "checksum", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if this template requires HVM", + "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": "requireshvm", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "isextractable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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": "isrouting", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "boolean" - } - ], - "related": "getUploadParamsForIso", - "response": [ - { - "description": "the template/volume ID", - "name": "id", "type": "uuid" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, - { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - } - ], - "since": "4.6.0" - }, - { - "description": "Resets network permissions.", - "isasync": false, - "name": "resetNetworkPermissions", - "params": [ - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Updates an existing Bgp Peer.", - "isasync": true, - "name": "updateBgpPeer", - "params": [ - { - "description": "The password of the Bgp Peer.", + "description": "32 or 64 bit", "length": 255, - "name": "password", + "name": "bits", "required": false, - "type": "string" + "type": "integer" }, { - "description": "BGP peer details in key/value pairs.", + "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 AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, - { - "description": "Id of the Bgp Peer", - "length": 255, - "name": "id", - "related": "updateBgpPeer", - "required": true, - "type": "uuid" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "The IPv4 address of the Bgp Peer.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "The IPv6 address of the Bgp Peer.", - "length": 255, - "name": "ip6address", + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" } ], - "related": "", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ - {}, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" - }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "id of the bgp peer", + "description": "the template ID", "name": "id", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the project name of the bgp peer", - "name": "project", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Release the dedication for host", - "isasync": true, - "name": "releaseDedicatedHost", - "params": [ - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, - {} - ] - }, - { - "description": "Accepts or declines project invitation", - "isasync": true, - "name": "updateProjectInvitation", - "params": [ { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "if true, accept the invitation, decline if false. True by default", - "length": 255, - "name": "accept", - "required": false, + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", - "length": 255, - "name": "token", - "required": false, + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "id of the project to join", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" - } - ], - "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 state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, - {}, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the availability zone", + "description": "the name of the zone for this template", "name": "zonename", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "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 list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 snapshot", + "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "path of the Domain the snapshot's account 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 status of the template", - "name": "status", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the 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 the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, + {}, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the project id of the template", + "name": "projectid", "type": "string" } ] }, { - "description": "Updates a condition for VM auto scaling", - "isasync": true, - "name": "updateCondition", + "description": "Lists dedicated clusters.", + "isasync": false, + "name": "listDedicatedClusters", "params": [ { - "description": "the ID of the condition.", + "description": "the ID of the domain associated with the cluster", "length": 255, - "name": "id", - "related": "", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, - { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" - }, - { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.18.0" - }, - { - "description": "Lists Regions", - "isasync": false, - "name": "listRegions", - "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "the ID of the cluster", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List Region by region name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List Region by region ID.", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" + }, + { + "description": "list dedicated clusters by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" } ], - "related": "addRegion", + "related": "", "response": [ - {}, - {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the name of the cluster", + "name": "clustername", + "type": "string" }, + {}, { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" + }, + { + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -111607,231 +115693,325 @@ ] }, { - "description": "Attempts Migration of a system virtual machine to the host specified.", + "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": "migrateSystemVm", + "name": "uploadCustomCertificate", "params": [ { - "description": "destination Host ID to migrate VM to", + "description": "A name / alias for the certificate.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "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", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", "required": false, - "since": "4.16.0", - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "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": "autoselect", + "name": "id", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "integer" + }, + { + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {} + ] + }, + { + "description": "Update quota calculations, alerts and statements", + "isasync": false, + "name": "quotaUpdate", + "params": [], + "related": "", + "response": [ { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "timestamp when the run got over", + "name": "updated_on", + "type": "date" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "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" + } + ], + "since": "4.7.0" + }, + { + "description": "list Tungsten-Fabric network", + "isasync": false, + "name": "listTungstenFabricNetwork", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "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" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the system VM", - "name": "id", + "description": "Tungsten-Fabric network uuid", + "name": "uuid", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "Tungsten-Fabric network name", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the state of the system VM", - "name": "state", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "addTrafficMonitor", + "response": [ + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "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 Zone name for the system VM", - "name": "zonename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "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.", + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Releases an existing dedicated Bgp Peer.", + "isasync": true, + "name": "releaseBgpPeer", + "params": [ { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -111840,157 +116020,152 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "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" } - ] + ], + "since": "4.20.0" }, { - "description": "List the counters for VM auto scaling", - "isasync": false, - "name": "listCounters", + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", "params": [ { - "description": "", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "pagesize", + "name": "privateendport", "required": false, "type": "integer" }, { - "description": "ID of the Counter.", + "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "createCounter,listCounters", - "required": false, + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" }, { - "description": "Network provider of the counter.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "provider", + "name": "customid", "required": false, - "since": "4.18.0", + "since": "4.4", "type": "string" }, { - "description": "Name of the counter.", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "name", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Source of the counter.", + "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, - "name": "source", + "name": "vmguestip", "required": false, + "since": "4.5", "type": "string" }, { - "description": "", + "description": "the private start port of the port forwarding rule", "length": 255, - "name": "page", + "name": "privateport", "required": false, "type": "integer" } ], - "related": "createCounter", + "related": "", "response": [ { - "description": "the id of the Counter", - "name": "id", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, - {}, { - "description": "Provider of the counter.", - "name": "provider", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" - } - ] - }, - { - "description": "Configures an Internal Load Balancer element.", - "isasync": true, - "name": "configureInternalLoadBalancerElement", - "params": [ - { - "description": "the ID of the internal lb provider", - "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement", - "required": true, - "type": "uuid" }, { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "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", @@ -111998,190 +116173,484 @@ "type": "string" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, {}, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Lists all available virtual router elements.", - "isasync": false, - "name": "listVirtualRouterElements", + "description": "Acquires and associates a public IP to an account.", + "isasync": true, + "name": "associateIpAddress", "params": [ { - "description": "List by keyword", + "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": "keyword", + "name": "isportable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list virtual router elements by id", + "description": "Deploy VM for the project", "length": 255, - "name": "id", - "related": "listVirtualRouterElements", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list virtual router elements by network service provider id", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "list network offerings by enabled state", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "enabled", + "name": "regionid", + "related": "", + "required": false, + "type": "integer" + }, + { + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The network this IP address should be associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" } ], - "related": "", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the domain associated with the provider", + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", "name": "domain", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + {}, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "list" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "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 account associated with the provider", - "name": "account", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "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": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Deletes snapshot policies for the account.", + "description": "Get the SF Volume Access Group IDs", "isasync": false, - "name": "deleteSnapshotPolicies", + "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "list of snapshots policy IDs separated by comma", + "description": "Cluster UUID", "length": 255, - "name": "ids", - "related": "updateSnapshotPolicy", - "required": false, - "type": "list" + "name": "clusterid", + "required": true, + "type": "string" }, { - "description": "the Id of the snapshot policy", + "description": "Storage Pool UUID", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" + "name": "storageid", + "required": true, + "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", - "type": "string" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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": "Deletes an existing IPv4 subnet for guest network.", + "description": "Delete site to site vpn connection", "isasync": true, - "name": "deleteIpv4SubnetForGuestNetwork", + "name": "deleteVpnConnection", "params": [ { - "description": "Id of the guest network IPv4 subnet", + "description": "id of vpn connection", "length": 255, "name": "id", "related": "", @@ -112195,6 +116664,12 @@ "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", @@ -112205,99 +116680,77 @@ "description": "the current status of the latest async job 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 implementors of implementor of a network traffic type or implementors of all network traffic types", + "description": "Lists all alerts types", "isasync": false, - "name": "listTrafficTypeImplementors", - "params": [ + "name": "listAlertTypes", + "params": [], + "related": "listAlerts", + "response": [ { - "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": "description of the alert", + "name": "description", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the alert", + "name": "name", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "network traffic type", - "name": "traffictype", + "description": "the id of the alert", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", - "type": "string" - }, - {} - ], - "since": "3.0.0" + } + ] }, { - "description": "Creates a routing firewall rule in the given network in ROUTED mode", + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", "isasync": true, - "name": "createRoutingFirewallRule", + "name": "createNetworkACL", "params": [ { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "traffictype", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "The network of the VM the firewall rule will be created for", + "description": "The network of the VM the ACL will be created for", "length": 255, "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": true, + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, "type": "uuid" }, { - "description": "the ending port of firewall rule", + "description": "the ending port of ACL", "length": 255, "name": "endport", "required": false, @@ -112311,82 +116764,146 @@ "type": "integer" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the 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 firewall rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "type of the ICMP message being sent", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "icmptype", + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + }, + { + "description": "The number of the ACL item, its ordering", + "length": 255, + "name": "number", "required": false, "type": "integer" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the starting port of ACL", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "fordisplay", + "name": "reason", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "destcidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" } ], - "related": "updateIpv6FirewallRule", + "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -112395,23 +116912,23 @@ "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -112420,1304 +116937,1511 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, - {}, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the 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 ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "link a cloudstack account to a group or OU in ldap", - "isasync": false, - "name": "linkAccountToLdap", + "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 group or OU in LDAP", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "ldapdomain", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "domain admin username in LDAP ", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "admin", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Creates the account under the specified role.", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "roleid", - "related": "importRole,listRoles", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.19.1", "type": "uuid" }, { - "description": "name of the account, it will be created if it does not exist", + "description": "The ID of the virtual machine", "length": 255, - "name": "account", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "an optional project for the ssh key", "length": 255, - "name": "accounttype", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "type", + "name": "keypair", "required": false, "type": "string" - }, - { - "description": "The id of the domain that is to contain the linked account.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" } ], - "related": "", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "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": "Type of the account to auto import", - "name": "accounttype", - "type": "int" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "list the db hosts and statistics", - "isasync": false, - "name": "listDbMetrics", - "params": [], - "related": "", - "response": [ { - "description": "the name of the active usage server", - "name": "hostname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", + "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 number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "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 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" }, - {} - ], - "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "true if operation is executed successfully", - "name": "success", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists autoscale vm profiles.", - "isasync": false, - "name": "listAutoScaleVmProfiles", - "params": [ + }, { - "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, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the otherdeployparameters of the autoscale vm profile", - "length": 255, - "name": "otherdeployparams", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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": "the name of the availability zone for the virtual machine", + "name": "zonename", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "list profiles by service offering id", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", - "required": false, - "type": "uuid" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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": "ssh key-pairs", + "name": "keypairs", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "createAutoScaleVmProfile", - "response": [ - { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "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", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, - {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the autoscale vm profile ID", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project name of the vm profile", + "description": "the project name of the vm", "name": "project", "type": "string" }, - {}, { - "description": "the domain name of the vm profile", + "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Disables out-of-band management for a host", - "isasync": true, - "name": "disableOutOfBandManagementForHost", - "params": [ - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", - "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the operation result description", - "name": "description", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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 port", - "name": "port", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", - "isasync": true, - "name": "cancelHostAsDegraded", - "params": [ - { - "description": "host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost,reconnectHost", - "response": [ - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "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": "CPU Arch of the host", - "name": "arch", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the host version", - "name": "version", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 list of nics associated with vm", + "name": "nic", + "response": [ + { + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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 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 if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the 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 cidr of IPv6 network", + "name": "ip6cidr", + "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": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the 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 project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "Model Name of vGPU", - "name": "vgputype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" + "description": "resource type", + "name": "resourcetype", + "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": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - {}, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the 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 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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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" + }, + { + "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" + } + ], + "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 list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "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": "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" } - ], - "since": "4.16.0.0" + ] }, { - "description": "Authorizes a particular ingress rule for this security group", + "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", "isasync": true, - "name": "authorizeSecurityGroupIngress", + "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "error code for this icmp message", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "name": "vlan", + "required": true, + "type": "string" }, { - "description": "type of the icmp message being sent", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "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 ending IP address.", "length": 255, - "name": "protocol", - "required": false, + "name": "endip", + "required": true, "type": "string" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "The starting IP address.", "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "name": "startip", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "an optional project of the security group", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.11.0.0" + }, + { + "description": "Add a supported Kubernetes version", + "isasync": false, + "name": "addKubernetesSupportedVersion", + "params": [ + { + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "account", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "start port for this ingress rule", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "startport", - "required": false, + "name": "mincpunumber", + "required": true, "type": "integer" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "user to security group mapping", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "usersecuritygrouplist", + "name": "url", "required": false, - "type": "map" + "type": "string" }, { - "description": "end port for this ingress rule", + "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": "endport", + "name": "directdownload", "required": false, - "type": "integer" + "since": "4.18.2", + "type": "boolean" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "semanticversion", + "required": true, + "type": "string" + }, + { + "description": "the ID of the zone in which Kubernetes supported version will be available", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "securitygroupname", - "required": false, - "type": "string" + "name": "minmemory", + "required": true, + "type": "integer" } ], - "related": "", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" + }, + { + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, - {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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 id of the Kubernetes supported version", + "name": "id", + "type": "string" + }, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" } ] }, { - "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": "Link or unlink a userdata to a template.", + "isasync": false, + "name": "linkUserDataToTemplate", "params": [ { - "description": "Storage pool id", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the ISO for the virtual machine", + "length": 255, + "name": "isoid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, "type": "uuid" + }, + { + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "length": 255, + "name": "userdatapolicy", + "required": false, + "type": "string" } ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ - {}, { - "description": "the storage pool type", - "name": "type", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the storage pool path", - "name": "path", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "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", @@ -113725,489 +118449,533 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, - {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "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": "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 physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the date and time the storage pool was created", + "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the template ID", "name": "id", "type": "string" } ], - "since": "4.15.1" + "since": "4.18.0" }, { - "description": "Releases an AS Number back to the pool", + "description": "Lists load balancer rules.", "isasync": false, - "name": "releaseASNumber", + "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "the zone ID", + "description": "region ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "regionid", + "related": "", + "required": false, + "type": "integer" }, { - "description": "the AS Number to be released", + "description": "List by keyword", "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "true if operation is executed successfully", - "name": "success", + "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" - } - ], - "since": "4.20.0" - }, - { - "description": "Creates a security group", - "isasync": false, - "name": "createSecurityGroup", - "params": [ - { - "description": "the description of the security group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "description", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "name of the security group", + "description": "", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Create security group for project", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "an optional account for the security group. 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 domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], - "related": "", + "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the security group belongs to", + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", "name": "domainpath", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project name of the group", - "name": "project", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 rule", - "name": "tags", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the public ip address", + "name": "publicip", "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": "tag key name", - "name": "key", + "description": "the name of the load balancer", + "name": "name", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the state of the rule", + "name": "state", "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "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 id of the guest network the lb rule belongs to", + "name": "networkid", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "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", + "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -114216,13 +118984,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -114231,128 +118999,113 @@ "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the public port", + "name": "publicport", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, - {} + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + } ] }, { - "description": "List network visibility and all accounts that have permissions to view this network.", - "isasync": false, - "name": "listNetworkPermissions", + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", "params": [ { - "description": "Lists network permission by network ID", + "description": "the ID of the Cluster", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], - "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of project the network is available for", - "name": "projectid", - "type": "string" - }, - { - "description": "the account the network is available for", - "name": "account", - "type": "string" - }, - { - "description": "the ID of account the network is available for", - "name": "accountid", - "type": "string" - }, - { - "description": "the name of the domain to which the network belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the network ID", - "name": "networkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "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" }, { @@ -114360,239 +119113,249 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} - ], - "since": "4.17.0" + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { - "description": "Updates Bucket properties", + "description": "Updates a disk offering.", "isasync": false, - "name": "updateBucket", + "name": "deleteDiskOffering", "params": [ { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" - }, - { - "description": "Enable/Disable Bucket Versioning", - "length": 255, - "name": "versioning", - "required": false, - "type": "boolean" - }, - { - "description": "The ID of the Bucket", + "description": "ID of the disk offering", "length": 255, "name": "id", "related": "", "required": true, "type": "uuid" - }, - { - "description": "Bucket Access Policy", - "length": 255, - "name": "policy", - "required": false, - "type": "string" - }, - { - "description": "Enable/Disable Bucket encryption", - "length": 255, - "name": "encryption", - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} - ], - "since": "4.19.0" + ] }, { - "description": "Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts.", + "description": "Get Kubernetes cluster config", "isasync": false, - "name": "updateResourceCount", + "name": "getKubernetesClusterConfig", "params": [ { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "account", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster", "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the id of the container cluster", + "name": "id", "type": "string" }, { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Update resource limits for project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "Name of the container cluster", + "name": "name", + "type": "string" }, { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "description": "the config data of the cluster", + "name": "configdata", + "type": "string" }, + {}, { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } + ] + }, + { + "description": "Deletes a autoscale policy.", + "isasync": true, + "name": "deleteAutoScalePolicy", + "params": [ + { + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": true, + "type": "uuid" + } ], - "related": "", "response": [ { - "description": "Tag for the resource", - "name": "tag", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id for which resource count's are updated", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a role", + "isasync": false, + "name": "deleteRole", + "params": [ { - "description": "path of the domain to which the resource counts are updated", - "name": "domainpath", + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.9.0" + }, + { + "description": " delete a Cisco Nexus VSM device", + "isasync": true, + "name": "deleteCiscoNexusVSM", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the project name for which resource count's are updated", - "name": "project", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The resource count", - "name": "resourcecount", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Lists site 2 site vpn gateways", + "description": "List internal LB VMs.", "isasync": false, - "name": "listVpnGateways", + "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "id of the vpn gateway", + "description": "the Zone ID of the Internal LB VM", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the state of the Internal LB VM", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "state", "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.", @@ -114602,18 +119365,27 @@ "type": "boolean" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the host ID of the Internal LB VM", "length": 255, - "name": "isrecursive", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the ID of the Internal LB VM", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { "description": "", @@ -114623,115 +119395,35 @@ "type": "integer" }, { - "description": "id of vpc", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "projectid", + "related": "", "required": false, "type": "uuid" - } - ], - "related": "createVpnGateway", - "response": [ - { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the vpc name of this gateway", - "name": "vpcname", - "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, - { - "description": "the public IP address", - "name": "publicip", - "type": "string" - }, - { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name", - "name": "project", - "type": "string" }, - {} - ] - }, - { - "description": "Lists dynamic roles in CloudStack", - "isasync": false, - "name": "listRoles", - "params": [ { - "description": "List by keyword", + "description": "the name of the Internal LB VM", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "page", + "name": "fetchhealthcheckresults", "required": false, - "type": "integer" + "since": "4.14", + "type": "boolean" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "list by network id", "length": 255, - "name": "type", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -114741,465 +119433,603 @@ "type": "integer" }, { - "description": "List role by role type status, valid options are: enabled, disabled", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List role by role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List role by role ID.", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "id", - "related": "importRole,listRoles", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" + }, + { + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" } ], - "related": "importRole", + "related": "listRouters", "response": [ { - "description": "the name of the role", - "name": "name", + "description": "the public netmask for the router", + "name": "publicnetmask", "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 state of the router", + "name": "state", + "type": "state" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the state of the role", - "name": "state", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the version of template", + "name": "version", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Download object at a specified path on an image store.", - "isasync": true, - "name": "downloadImageStoreObject", - "params": [ + }, { - "description": "path to download on image store", - "length": 255, - "name": "path", - "required": false, + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "id of the image store", - "length": 255, - "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": true, - "type": "uuid" - } - ], - "related": "extractSnapshot,extractTemplate", - "response": [ - {}, - { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "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 entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the id of extracted object", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "", - "name": "resultstring", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the guest IP address for the router", + "name": "guestipaddress", "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 account id to which the extracted object belongs", - "name": "accountid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "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 the router", + "name": "name", "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": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the cloud identifier", - "name": "cloudidentifier", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" - } - ] - }, - { - "description": "Creates a load balancer stickiness policy ", - "isasync": true, - "name": "createLBStickinessPolicy", - "params": [ + }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", - "length": 255, - "name": "param", - "required": false, - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the load balancer stickiness policy", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "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 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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "description": "the first DNS for the router", + "name": "dns1", + "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": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, + {}, { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", - "length": 255, - "name": "methodname", - "required": true, + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" - } - ], - "related": "listLBStickinessPolicies", - "response": [ + }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, - {}, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", + "description": "the Zone ID for the router", "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "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", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, - {}, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - } - ], - "type": "list" - } - ], - "since": "3.0.0" - }, - { - "description": "Configures a Palo Alto firewall device", - "isasync": true, - "name": "configurePaloAltoFirewall", - "params": [ + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, - "type": "long" - } - ], - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "response": [ + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "role of the domain router", + "name": "role", "type": "string" }, - {}, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Lists Cisco VNMC controllers", + "isasync": false, + "name": "listCiscoVnmcResources", + "params": [ + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "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" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, + {}, + {}, + {}, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "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": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" + "description": "ID of cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "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" }, {}, { @@ -115208,328 +120038,338 @@ "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, + {}, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Updates ACL item with specified ID", + "description": "Deletes a particular egress rule from this security group", "isasync": true, - "name": "updateNetworkACLItem", + "name": "revokeSecurityGroupEgress", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The ID of the egress rule", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", - "length": 255, - "name": "number", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Uploads an icon for the specified resource(s)", + "isasync": false, + "name": "uploadResourceIcon", + "params": [ { - "description": "the ending port of ACL", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "type of the resource", "length": 255, - "name": "traffictype", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, + "type": "string" + } + ], + "response": [ + {}, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, + "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": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "description": "the enabled or disabled state of the Kubernetes supported version", "length": 255, - "name": "partialupgrade", - "required": false, - "type": "boolean" + "name": "state", + "required": true, + "type": "string" }, { - "description": "the ID of the network ACL item", + "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" } ], - "related": "moveNetworkAclItem", + "related": "listKubernetesSupportedVersions", "response": [ { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "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 ending port of ACL's port range", - "name": "endport", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, {}, { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" } ] }, { - "description": "Moves a user to another account in the same domain.", - "isasync": false, - "name": "moveUser", + "description": "Deletes an existing IPv4 subnet for a zone.", + "isasync": true, + "name": "deleteIpv4SubnetForZone", "params": [ { - "description": "id of the user to be moved.", + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "createUser,enableUser,getUser", + "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "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": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, + "name": "zoneid", + "related": "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": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + { + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -115537,407 +120377,467 @@ "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": "id of the guest IPv6 prefix", + "name": "id", "type": "string" } ], - "since": "4.11" + "since": "4.17.0.0" }, { - "description": "List routers.", + "description": "Creates a role", "isasync": false, - "name": "listRouters", + "name": "createRole", "params": [ { - "description": "", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "healthchecksfailed", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "since": "4.16", - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", "length": 255, - "name": "isrecursive", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "list virtual router elements by version", + "description": "The description of the role", "length": 255, - "name": "version", + "name": "description", "required": false, "type": "string" }, { - "description": "the state of the router", + "description": "Creates a role with this unique name", "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listRoles,updateRole", + "response": [ + { + "description": "the type of the role", + "name": "type", + "type": "string" + }, + { + "description": "the state of the role", "name": "state", - "required": false, "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 role", + "name": "id", "type": "string" }, + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the description of the role", + "name": "description", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the disk router", - "length": 255, - "name": "id", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the router", - "length": 255, + "description": "the name of the role", "name": "name", - "required": false, "type": "string" }, + {}, { - "description": "the cluster ID of the router", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Upload a data disk to the cloudstack cloud.", + "isasync": false, + "name": "getUploadParamsForVolume", + "params": [ + { + "description": "the name of the volume/template/iso", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "forvpc", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "fetchhealthcheckresults", - "required": false, - "since": "4.14", - "type": "boolean" + "name": "format", + "required": true, + "type": "string" }, { - "description": "the Pod ID of the router", + "description": "Image store uuid", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "imagestoreuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List networks by VPC", + "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": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network id", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the host ID of the router", + "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": "hostid", - "related": "addBaremetalHost,reconnectHost", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the router", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, "name": "zoneid", - "related": "createZone,listZones", - "required": false, + "related": "listZones", + "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "destroyRouter", + "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, + {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { - "description": "the template ID for the router", - "name": "templateid", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, - {}, + {} + ], + "since": "4.6.0" + }, + { + "description": "Updates an existing autoscale vm profile.", + "isasync": true, + "name": "updateAutoScaleVmProfile", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "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" }, - {}, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "length": 255, + "name": "expungevmgraceperiod", + "required": false, + "type": "integer" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "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", + "type": "boolean" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "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, + "since": "4.18.0", + "type": "map" }, { - "description": "the id of the router", - "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, + "since": "4.4", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "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" - }, + } + ], + "related": "listAutoScaleVmProfiles", + "response": [ { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, + {}, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the project name of the address", + "description": "the project name of the vm profile", "name": "project", "type": "string" }, + {}, + {}, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "Base64 encoded VM user data", + "name": "userdata", + "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the Zone ID for the router", + "description": "the availability zone to be used while deploying a virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - }, + } + ] + }, + { + "description": "Enables an AutoScale Vm Group", + "isasync": true, + "name": "enableAutoScaleVmGroup", + "params": [ { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -115945,1069 +120845,1260 @@ "type": "integer" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, + {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the version of template", - "name": "version", - "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 second DNS for the router", - "name": "dns2", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "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": "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 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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" - } - ] - }, - { - "description": "Releases host reservation.", - "isasync": true, - "name": "releaseHostReservation", - "params": [ + }, { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the public port", + "name": "publicport", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private port", + "name": "privateport", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + {}, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, - {} + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + } ] }, { - "description": "Create site to site vpn connection", - "isasync": true, - "name": "createVpnConnection", + "description": "Lists guest network IPv6 prefixes", + "isasync": false, + "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "connection is passive or not", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "passive", + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "id of the vpn gateway", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "id of the customer gateway", + "description": "", "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" }, { - "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 domain id of the owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "isasync": true, + "name": "updateGuestOsMapping", + "params": [ { - "description": "the project name", - "name": "project", + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "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 date and time the host was created", - "name": "created", - "type": "date" - }, + "description": "UUID of the Guest OS to hypervisor name Mapping", + "length": 255, + "name": "id", + "related": "updateGuestOsMapping", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the connection ID", + "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" }, + {}, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "delete Tungsten-Fabric tag", + "isasync": true, + "name": "deleteTungstenFabricTag", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "State of vpn connection", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "lists network that are using a brocade vcs switch", + "description": "Update password of a host/pool on management server.", "isasync": false, - "name": "listBrocadeVcsDeviceNetworks", + "name": "updateHostPassword", "params": [ { - "description": "", + "description": "the username for the host/cluster", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "username", + "required": true, + "type": "string" }, { - "description": "brocade vcs switch ID", + "description": "the new password for the host/cluster", "length": 255, - "name": "vcsdeviceid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "keyword", + "name": "update_passwd_on_host", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the host ID", "length": 255, - "name": "page", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ + {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the network", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "adds a range of portable public IP's to a region", + "isasync": true, + "name": "createPortableIpRange", + "params": [ + { + "description": "the netmask of the portable IP range", + "length": 255, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the gateway for the portable IP range", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the beginning IP address in the portable IP range", + "length": 255, + "name": "startip", + "required": true, + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the ending IP address in the portable IP range", + "length": 255, + "name": "endip", + "required": true, "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "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": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "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": "Id of the Region", + "length": 255, + "name": "regionid", + "related": "", + "required": true, + "type": "integer" }, + { + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the end ip of the portable IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", "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": "the list of resource tags associated with network", - "name": "tags", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" } ], "type": "list" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes Webhook delivery", + "isasync": false, + "name": "deleteWebhookDelivery", + "params": [ { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "The ID of the management server", + "length": 255, + "name": "managementserverid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook", + "required": false, + "type": "uuid" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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": "the physical network id", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists the VMs in a VMware Datacenter", + "isasync": false, + "name": "listVmwareDcVms", + "params": [ { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "UUID of a linked existing vCenter", + "length": 255, + "name": "existingvcenterid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "listUnmanagedInstances", + "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", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the 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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" - }, + } + ] + }, + { + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", + "params": [ { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "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": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", + "required": false, "type": "string" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" + } + ], + "related": "addCluster", + "response": [ + { + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + } + ], + "type": "list" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "The external id of the network", - "name": "externalid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the cluster name", + "name": "name", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, + {}, { - "description": "the details of the network", - "name": "details", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", "type": "map" }, { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "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": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the cluster ID", + "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 Zone name of the cluster", + "name": "zonename", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" } ] }, { - "description": "Lists Webhook deliveries", + "description": "List profile in ucs manager", "isasync": false, - "name": "listWebhookDeliveries", + "name": "listUcsProfiles", "params": [ { - "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": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The ID of the management server", + "description": "the id for the ucs manager", "length": 255, - "name": "managementserverid", + "name": "ucsmanagerid", "related": "", - "required": false, + "required": true, "type": "uuid" }, - { - "description": "The event type of the Webhook delivery", - "length": 255, - "name": "eventtype", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -117016,242 +122107,166 @@ "type": "integer" }, { - "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the Webhook", + "description": "", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "createWebhook", + "related": "", "response": [ - { - "description": "The scope of the Webhook", - "name": "scope", - "type": "string" - }, {}, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" - }, - { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The ID of the Webhook", - "name": "id", + "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 Webhook exists", - "name": "domain", + "description": "ucs profile dn", + "name": "ucsdn", "type": "string" - }, + } + ] + }, + { + "description": "Lists storage providers.", + "isasync": false, + "name": "listStorageProviders", + "params": [ { - "description": "The account associated with the Webhook", - "name": "account", + "description": "the type of storage provider: either primary or image", + "length": 255, + "name": "type", + "required": true, "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", - "type": "string" - }, - { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" - }, - { - "description": "The description of the Webhook", - "name": "description", + "description": "the type of the storage provider: primary or image provider", + "name": "type", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the storage provider", + "name": "name", "type": "string" }, + {}, { - "description": "The name of the Webhook", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "Deletes a Physical Network.", - "isasync": true, - "name": "deletePhysicalNetwork", + "description": "This command allows the user to query the seceret and API keys for the account", + "isasync": false, + "name": "getUserKeys", "params": [ { - "description": "the ID of the Physical network", + "description": "ID of the user whose keys are required", "length": 255, "name": "id", - "related": "createPhysicalNetwork", + "related": "disableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" } ], + "related": "", "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, + { + "description": "the api key of the registered user", + "name": "apikey", + "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 secret key of the registered user", + "name": "secretkey", "type": "string" } ], - "since": "3.0.0" + "since": "4.10.0" }, { - "description": "Creates a Webhook", - "isasync": false, - "name": "createWebhook", + "description": "update global load balancer rules.", + "isasync": true, + "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "Project for the Webhook", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "State of the Webhook", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "Payload URL of the Webhook", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "payloadurl", + "name": "id", + "related": "updateGlobalLoadBalancerRule", "required": true, - "type": "string" - }, - { - "description": "Description for the Webhook", - "length": 255, - "name": "description", - "required": false, - "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": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, "type": "uuid" }, { - "description": "Secret key of the Webhook", - "length": 255, - "name": "secretkey", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "Name for the Webhook", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Scope of the Webhook", + "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": "scope", + "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "An optional account for the Webhook. Must be used with domainId.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "account", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" } @@ -117259,70 +122274,239 @@ "related": "", "response": [ { - "description": "The description of the Webhook", - "name": "description", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, {}, - {}, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" - }, - { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public ip address", + "name": "publicip", + "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 public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -117331,62 +122515,65 @@ "type": "integer" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "Dedicates a host.", - "isasync": true, - "name": "dedicateHost", + "description": "Lists host tags", + "isasync": false, + "name": "listHostTags", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the host to update", + "description": "", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the containing domain", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "listDedicatedHosts", + "related": "", "response": [ { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" + }, + {}, + { + "description": "the ID of the host tag", + "name": "id", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the name of the host tag", + "name": "name", "type": "string" }, { @@ -117395,436 +122582,519 @@ "type": "integer" }, { - "description": "the domain ID of the host", - "name": "domainid", - "type": "string" + "description": "true if the host tag is implicit", + "name": "isimplicit", + "type": "boolean" }, {}, - { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the name of the host", - "name": "hostname", - "type": "string" - }, - {} + } ] }, { - "description": "Removes vpn user", + "description": "Add a new guest OS type", "isasync": true, - "name": "removeVpnUser", + "name": "addGuestOs", "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "Optional name for Guest OS", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "remove vpn user from the project", + "description": "Map of (key/value pairs)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "Unique display name for Guest OS", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "osdisplayname", + "required": true, + "type": "string" }, { - "description": "username for the vpn user", + "description": "ID of Guest OS category", "length": 255, - "name": "username", + "name": "oscategoryid", + "related": "listOsCategories", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the name of the OS category", + "name": "oscategoryname", + "type": "string" + }, + {}, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the OS type", + "name": "id", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" } - ] + ], + "since": "4.4.0" }, { - "description": "Adds the GloboDNS external host", - "isasync": true, - "name": "addGloboDnsHost", + "description": "add an annotation.", + "isasync": false, + "name": "addAnnotation", "params": [ { - "description": "GloboDNS url", + "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": "url", - "required": true, + "name": "entitytype", + "required": false, "type": "string" }, { - "description": "Password for GloboDNS", + "description": "the id of the entity to annotate", "length": 255, - "name": "password", - "required": true, + "name": "entityid", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "the annotation is visible for admins only", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "adminsonly", + "required": false, + "since": "4.16.0", + "type": "boolean" }, { - "description": "Username for GloboDNS", + "description": "the annotation text", "length": 255, - "name": "username", - "required": true, + "name": "annotation", + "required": false, "type": "string" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", + "type": "string" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + { + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, {}, + {}, + { + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } ], - "since": "4.5.0" + "since": "4.11" }, { - "description": "List public IP addresses in quarantine.", - "isasync": false, - "name": "listQuarantinedIps", + "description": "Creates new NS Vpx", + "isasync": true, + "name": "deployNetscalerVpx", "params": [ { - "description": "", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "Show IPs that are no longer in quarantine.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "showinactive", - "required": false, - "type": "boolean" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Show IPs removed from quarantine.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "showremoved", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", + "response": [ + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + {}, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" - } - ], - "related": "updateQuarantinedIp", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, - {}, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "device name", + "name": "lbdevicename", "type": "string" }, - {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, + {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" - } - ], - "since": "4.19" - }, - { - "description": "Logs out the user", - "isasync": false, - "name": "logout", - "params": [], - "related": "", - "response": [ - { - "description": "Response description", - "name": "description", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 public interface of the load balancer", + "name": "publicinterface", "type": "string" } ] }, { - "description": "Deletes a load balancer health check policy.", - "isasync": true, - "name": "deleteLBHealthCheckPolicy", + "description": "Lists the volumes of elastistor", + "isasync": false, + "name": "listElastistorVolume", "params": [ { - "description": "the ID of the load balancer health check policy", + "description": "the ID of the account", "length": 255, "name": "id", - "related": "", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "graceallowed", + "name": "graceallowed", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "compression", + "name": "compression", + "type": "string" + }, + { + "description": "the id of the volume", + "name": "id", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.2.0" + "description": "deduplication", + "name": "deduplication", + "type": "string" + }, + { + "description": "the name of the volume", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "synchronization", + "name": "sync", + "type": "string" + }, + {} + ] }, { - "description": "Imports a role based on provided map of rule permissions", - "isasync": false, - "name": "importRole", + "description": "add a baremetal pxe server", + "isasync": true, + "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "Creates a role with this unique name", + "description": "Pod Id", "length": 255, - "name": "name", + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "URL of the external pxe device", + "length": 255, + "name": "url", "required": true, "type": "string" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "the Physical Network ID", "length": 255, - "name": "rules", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "map" + "type": "uuid" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "type of pxe device", "length": 255, - "name": "type", - "required": false, + "name": "pxeservertype", + "required": true, "type": "string" }, { - "description": "The description of the role", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "description", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "tftpdir", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, {}, { - "description": "the ID of the role", + "description": "device id of ", "name": "id", "type": "string" }, { - "description": "the state of the role", - "name": "state", + "description": "url", + "name": "url", "type": "string" }, { - "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": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "type", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the description of the role", - "name": "description", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" } - ], - "since": "4.15.0" + ] }, { - "description": "List Swift.", + "description": "Lists Nicira NVP devices", "isasync": false, - "name": "listSwifts", + "name": "listNiciraNvpDevices", "params": [ { - "description": "the id of the swift", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "long" + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -117836,45 +123106,49 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "nicira nvp device ID", "length": 255, - "name": "pagesize", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "addImageStoreS3,listImageStores", + "related": "addNiciraNvpDevice", "response": [ - {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "device name", + "name": "niciradevicename", + "type": "string" + }, + { + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -117883,13 +123157,8 @@ "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, { @@ -117898,1373 +123167,1865 @@ "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Lists all alerts.", + "isasync": false, + "name": "listAlerts", + "params": [ { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "list by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "list by alert name", + "length": 255, + "name": "name", + "required": false, + "since": "4.3", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { - "description": "ID of the host", + "description": "the ID of the alert", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": true, + "name": "id", + "related": "listAlerts", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ {}, + { + "description": "the id of the alert", + "name": "id", + "type": "string" + }, + { + "description": "description of the alert", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the alert", + "name": "name", "type": "string" }, + {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" } - ], - "since": "4.11" + ] }, { - "description": "Enables out-of-band management for a host", + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", "isasync": true, - "name": "enableOutOfBandManagementForHost", + "name": "deployVirtualMachine", "params": [ { - "description": "the ID of the host", + "description": "used to specify the vApp properties.", "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "related": "disableOutOfBandManagementForCluster", - "response": [ + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" + }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "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 operation result description", - "name": "description", - "type": "string" + "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": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, { - "description": "the ID of the host", - "name": "hostid", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "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 ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "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 out-of-band management interface username", - "name": "username", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "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" - } - ], - "since": "4.9.0" - }, - { - "description": "Deletes a service offering.", - "isasync": false, - "name": "deleteServiceOffering", - "params": [ + }, { - "description": "the ID of the service offering", + "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": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "Adds a Nicira NVP device", - "isasync": true, - "name": "addNiciraNvpDevice", - "params": [ { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "an optional group for the virtual machine", "length": 255, - "name": "hostname", - "required": true, + "name": "group", + "required": false, "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "l3gatewayserviceuuid", + "name": "bootintosetup", "required": false, - "type": "string" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "l2gatewayserviceuuid", + "name": "keypair", "required": false, "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "transportzoneuuid", - "required": true, - "type": "string" + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "username", - "required": true, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "device name", - "name": "niciradevicename", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "length": 255, + "name": "keyboard", + "required": false, "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", - "type": "string" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", + "type": "uuid" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "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 transport zone Uuid", - "name": "transportzoneuuid", - "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": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "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": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "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": "Restart a Shared FileSystem", - "isasync": true, - "name": "restartSharedFileSystem", - "params": [ + }, { - "description": "the ID of the shared filesystem", + "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": "id", + "name": "affinitygroupids", "related": "", - "required": true, - "type": "uuid" + "required": false, + "type": "list" }, { - "description": "is cleanup required", + "description": "Deploy vm for the project", "length": 255, - "name": "cleanup", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "", + "required": false, + "type": "list" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Lists network serviceproviders for a given physical network.", - "isasync": false, - "name": "listNetworkServiceProviders", - "params": [ { - "description": "", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "page", + "name": "startvm", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list providers by name", + "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "keyword", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "list providers by state", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "state", + "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" } ], - "related": "", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the provider name", - "name": "name", - "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists infrastructure", - "isasync": false, - "name": "listInfrastructure", - "params": [], - "related": "", - "response": [ + }, { - "description": "Number of management servers", - "name": "managementservers", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "Number of Alerts", - "name": "alerts", - "type": "integer" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {}, { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, - {}, { - "description": "Number of zones", - "name": "zones", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Number of storage pools", - "name": "storagepools", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "Number of pods", - "name": "pods", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Number of object stores", - "name": "objectstores", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "Number of images stores", - "name": "imagestores", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Number of routers", - "name": "routers", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "Number of systemvms", - "name": "systemvms", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", - "type": "integer" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists usage records for accounts", - "isasync": false, - "name": "listUsageRecords", - "params": [ - { - "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": "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": "Flag to enable display of Tags for a resource", - "length": 255, - "name": "includetags", - "required": false, - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", - "length": 255, - "name": "oldformat", - "required": false, - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "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": "enddate", - "required": true, - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "List usage records for the specified user.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "List usage records for specified project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "List usage records for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "List usage records for the specified usage type", - "length": 255, - "name": "type", - "required": false, - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", - "length": 255, - "name": "usageid", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "virtual machine ID", - "name": "virtualmachineid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "offering ID", - "name": "offeringid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "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": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + {}, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the domain the resource is associated with", + "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "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": "raw usage in hours", - "name": "rawusage", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the domain ID", - "name": "domainid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "usage type ID", - "name": "usagetype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the user account Id", - "name": "accountid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the user account name", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the gateway of the nic", + "name": "gateway", "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 account associated with the tag", - "name": "account", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "date" - }, - { - "description": "path of the domain to which the usage reocrd belongs", - "name": "domainpath", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "date" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, + {}, { - "description": "resource or virtual machine name", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "description of the usage record", - "name": "description", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "template ID", - "name": "templateid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "resource size", - "name": "size", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "id of the network", - "name": "networkid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the project id of the resource", - "name": "projectid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" - } - ] - }, - { - "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": "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", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Delete Netscaler Control Center", - "isasync": false, - "name": "deleteNetscalerControlCenter", - "params": [ - { - "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 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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a detached disk volume.", - "isasync": false, - "name": "deleteVolume", - "params": [ - { - "description": "The ID of the disk volume", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Recovers a Destroy volume.", - "isasync": false, - "name": "recoverVolume", - "params": [ - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "name of the disk volume", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "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": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "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 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", + "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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 project name where tag belongs to", - "name": "project", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id of the group", + "name": "projectid", "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 description of the security group", + "name": "description", "type": "string" } ], "type": "set" - }, + } + ] + }, + { + "description": "Lists all volumes.", + "isasync": false, + "name": "listVolumes", + "params": [ { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list only volumes that are encrypted", + "length": 255, + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "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": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "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": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.19.1", + "type": "uuid" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the account associated with the disk volume", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "since": "4.9", + "type": "list" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "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 project id of the vpn", - "name": "projectid", + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "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": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, + "type": "string" + } + ], + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { @@ -119273,34 +125034,35 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { "description": "the status of the volume", @@ -119308,34 +125070,34 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { "description": "the path of the volume", @@ -119343,516 +125105,526 @@ "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - } - ], - "since": "4.14.0" - }, - { - "description": "Lists unmanaged volumes on a storage pool", - "isasync": false, - "name": "listVolumesForImport", - "params": [ - { - "description": "the path of the volume on the storage pool", - "length": 255, - "name": "path", - "required": false, + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the path of the volume", - "name": "path", - "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the primary storage hosting the volume", - "name": "storage", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the format of the volume", - "name": "format", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, {}, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the virtual size of the volume", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the size of the volume", + "description": "size of the disk volume", "name": "size", "type": "long" }, { - "description": "volume details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "id of the primary storage hosting the volume", - "name": "storageid", - "type": "string" - }, - { - "description": "the encrypt format of the volume", - "name": "encryptformat", - "type": "string" - }, - { - "description": "type of the primary storage hosting the volume", - "name": "storagetype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the full path of the volume", - "name": "fullpath", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "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" - } - ], - "since": "4.19.1" - }, - { - "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", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" }, { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Enables a user account", - "isasync": false, - "name": "enableUser", - "params": [ - { - "description": "Enables user by user ID.", - "length": 255, - "name": "id", - "related": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "createUser,getUser", - "response": [ { - "description": "the domain ID of the user", - "name": "domainid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the date and time the user account was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the user lastname", - "name": "lastname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, - {}, { - "description": "the api key of the user", - "name": "apikey", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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 type of the role", - "name": "roletype", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" } ] }, { - "description": "Lists zone metrics", - "isasync": false, - "name": "listZonesMetrics", + "description": "Creates a load balancer health check policy", + "isasync": true, + "name": "createLBHealthCheckPolicy", "params": [ { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "networktype", + "name": "responsetimeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "available", + "name": "unhealthythreshold", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the name of the zone", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "HTTP ping path", "length": 255, - "name": "keyword", + "name": "pingpath", "required": false, "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "the ID of the load balancer rule", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "page", + "name": "healthythreshold", "required": false, "type": "integer" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "since": "4.3", - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the domain associated with the zone", + "description": "Amount of time between health checks (1 sec - 20940 sec)", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "intervaltime", "required": false, - "type": "uuid" - }, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the IDs of the zones, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "createZone,listZones", - "required": false, - "since": "4.19.0", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", + "response": [ + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "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": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + } + ], "type": "list" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + {}, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "flag to display the capacity of the zones", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the zone", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Change Service offering of a Shared FileSystem", + "isasync": true, + "name": "changeSharedFileSystemServiceOffering", + "params": [ + { + "description": "the ID of the shared filesystem", "length": 255, "name": "id", - "related": "createZone,listZones", - "required": false, + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "the offering to use for the shared filesystem instance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, - {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -119861,609 +125633,917 @@ "type": "integer" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the Zone name", - "name": "zonename", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "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": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" }, + {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "Network name of the shared filesystem", + "name": "networkname", "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 domain associated with the shared filesystem", + "name": "domainid", + "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "healthy / total clusters in the zone", - "name": "clusters", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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": "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the 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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "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" } ], - "type": "set" + "type": "list" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Locks a user account", + "isasync": false, + "name": "lockUser", + "params": [ + { + "description": "Locks user by user ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "disableUser,getUser,listUsers", + "response": [ + { + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the user ID", + "name": "id", "type": "string" }, + {}, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "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 domain ID of the user", + "name": "domainid", + "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": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ] + }, + { + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Cloudian Management Console base URL", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.9.3" + "since": "4.11.0" }, { - "description": "Extracts a template", - "isasync": true, - "name": "extractTemplate", + "description": "Creates a network", + "isasync": false, + "name": "createNetwork", "params": [ { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "mode", - "required": true, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the ID of the template", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "ip6cidr", + "required": false, + "type": "string" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "the AS Number of the network", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "asnumber", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "long" }, { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "Account that will own the network. Account should be under the selected domain", + "length": 255, + "name": "account", "required": false, "type": "string" - } - ], - "related": "extractSnapshot", - "response": [ + }, { - "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 beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the beginning IP address in the network IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "length": 255, + "name": "acltype", + "required": false, "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "Network ACL ID associated for the network", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" }, { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" + "description": "the network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "Ids of the Bgp Peer for the network", + "length": 255, + "name": "bgppeerids", + "related": "", + "required": false, + "since": "4.20.0", + "type": "list" + }, + { + "description": "the display text of the network", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, - {}, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the gateway of the IPv6 network. Required for Shared networks", + "length": 255, + "name": "ip6gateway", + "required": false, + "type": "string" }, - {}, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "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": "", - "name": "resultstring", + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "ID of the network in an external system.", + "length": 255, + "name": "externalid", + "required": false, "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "an optional project for the network", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the second IPv6 DNS for the network", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", - "isasync": true, - "name": "expungeVirtualMachine", - "params": [ + "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 ID of the virtual machine", + "description": "The network this network is associated to. only available if create a Shared network", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "since": "4.17.0", "type": "uuid" - } - ], - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "IPV6 address to be assigned to a router in a shared network", + "length": 255, + "name": "routeripv6", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the first IPv6 DNS for the network", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, - {}, - {}, { - "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" - } - ] - }, - { - "description": "Suspends a project", - "isasync": true, - "name": "suspendProject", - "params": [ + }, { - "description": "id of the project to be suspended", + "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": "id", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - } - ], - "related": "activateProject", - "response": [ + "name": "subdomainaccess", + "required": false, + "type": "boolean" + }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the isolated private VLAN type for this network", + "length": 255, + "name": "isolatedpvlantype", + "required": false, "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the name of the network", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "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 total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the second IPv4 DNS for the network", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the first IPv4 DNS for the network", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "length": 255, + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "IPV4 address to be assigned to a router in a shared network", + "length": 255, + "name": "routerip", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the physical network ID the network belongs to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "length": 255, + "name": "cidrsize", + "required": false, + "since": "4.20.0", + "type": "integer" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "Tungsten-Fabric virtual router the network belongs to", + "length": 255, + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "the name of the project", - "name": "name", + "description": "the zone ID for the network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" + } + ], + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { @@ -120472,491 +126552,422 @@ "type": "resourceiconresponse" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the id of the network", + "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 zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, - {}, { - "description": "the list of resource tags associated with vm", - "name": "tags", + "description": "the list of services", + "name": "service", "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "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 total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an IP address", - "isasync": true, - "name": "updateIpAddress", - "params": [ + "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 IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "an optional field, 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the public IP address to update", - "length": 255, - "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "associateIpAddress,listPublicIpAddresses", - "response": [ + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, - {}, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", + "description": "the date this network was created", + "name": "created", "type": "date" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "public IP address id", - "name": "id", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, - {}, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "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": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { "description": "the project id of the ipaddress", @@ -120964,222 +126975,371 @@ "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "VPC id the ip belongs to", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "VPC the network belongs to", "name": "vpcid", "type": "string" - } - ] - }, - { - "description": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ + }, { - "description": "the account name of the api remaining count", - "name": "account", + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + } + ] + }, + { + "description": "Lists all available network offerings.", + "isasync": false, + "name": "listNetworkOfferings", + "params": [ + { + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", + "required": false, "type": "string" }, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the tags for the network offering.", + "length": 255, + "name": "specifyvlan", + "required": false, + "type": "boolean" + }, + { + "description": "true if offering has tags specified", + "length": 255, + "name": "istagged", + "required": false, + "type": "boolean" + }, + { + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, - {}, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" + "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 ID", + "length": 255, + "name": "id", + "related": "listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "list network offerings by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" + "description": "list network offerings supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" - } - ] - }, - { - "description": "Deletes a storage network IP Range.", - "isasync": true, - "name": "deleteStorageNetworkIpRange", - "params": [ + "description": "true if need to list only default network offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" + }, { - "description": "the uuid of the storage network ip range", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange", - "required": true, + "name": "keyword", + "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" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list by traffic type", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network offering can be used only for network creation inside the VPC", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" + }, + { + "description": "list network offerings available for network creation in specific domain", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "list network offerings by display text", + "length": 255, + "name": "displaytext", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "moves a network to another physical network", - "isasync": true, - "name": "migrateNetwork", - "params": [ + "description": "list network offerings by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { - "description": "true if previous network migration cmd failed", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "resume", + "name": "availability", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "network offering ID", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "name": "sourcenatsupported", + "required": false, + "type": "boolean" }, { - "description": "the ID of the network", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" + "name": "routingmode", + "required": false, + "since": "4.20.0", + "type": "string" } ], - "related": "createNetwork,updateNetwork,listNetworks", + "related": "", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + {}, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "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": "related to what other network configuration", - "name": "related", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the list of services", + "description": "the list of supported services", "name": "service", "response": [ { "description": "the service provider name", "name": "provider", "response": [ - { - "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", @@ -121190,31 +127350,46 @@ "name": "servicelist", "type": "list" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { @@ -121223,94 +127398,79 @@ "type": "boolean" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "true if network is default, false otherwise", + "description": "true if network offering is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "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 date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -121319,218 +127479,339 @@ "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "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 dedicated pods.", + "isasync": false, + "name": "listDedicatedPods", + "params": [ { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "list dedicated pods by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the account associated with the pod. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the 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 pod", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "state of the network", - "name": "state", + "description": "the ID of the domain associated with the pod", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the Pod", + "name": "podid", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the Name of the Pod", + "name": "podname", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists VPCs", + "isasync": false, + "name": "listVPCs", + "params": [ + { + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "list VPC supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "list by zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "list VPC by id", + "length": 255, + "name": "id", + "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": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "flag to display the resource icon for VPCs", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "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 VPC to which this network belongs", - "name": "vpcname", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" + "description": "list VPCs by restartRequired option", + "length": 255, + "name": "restartrequired", + "required": false, + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "list VPCs by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "list by ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": false, + "type": "uuid" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "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 second IPv4 DNS for the network", - "name": "dns2", + "description": "list by name of the VPC", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, + } + ], + "related": "createVPC,listVPCs,updateVPC", + "response": [ {}, { - "description": "the name of the zone the network belongs to", + "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -121539,192 +127820,118 @@ "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "list" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "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": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the second IPv6 DNS for the network", + "description": "the second IPv6 DNS for the VPC", "name": "ip6dns2", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, - {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "type": "boolean" - } - ], - "since": "4.11.0" - }, - { - "description": "Updates Ipv6 firewall rule with specified ID", - "isasync": true, - "name": "updateIpv6FirewallRule", - "params": [ - { - "description": "the ID of the ipv6 firewall rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, + {}, { - "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", - "length": 255, + "description": "is vpc for display to the regular user", "name": "fordisplay", - "required": false, - "since": "4.4", "type": "boolean" }, { - "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, + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "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", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -121732,538 +127939,289 @@ "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of supported services", + "name": "service", "response": [ { - "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": "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": "resource type", - "name": "resourcetype", - "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": "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", - "name": "customer", + "description": "the service name", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, - {}, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" } ] }, { - "description": "Lists unmanaged virtual machines for a given cluster.", - "isasync": false, - "name": "listUnmanagedInstances", + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "isasync": true, + "name": "runDiagnostics", "params": [ { - "description": "the cluster ID", + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "type", "required": true, - "type": "uuid" - }, - { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "The IP/Domain address to test connection to", "length": 255, - "name": "keyword", - "required": false, + "name": "ipaddress", + "required": true, "type": "string" }, { - "description": "", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "targetid", + "related": "startSystemVm", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "page", + "name": "params", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the standard error output from the command execution", + "name": "stderr", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the command execution return code", + "name": "exitcode", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the 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": "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 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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the standard output from the command execution", + "name": "stdout", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - } - ], - "type": "set" - }, {}, - { - "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 operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" } ], - "since": "4.14.0" + "since": "4.12.0.0" }, { - "description": "Updates ISO permissions", + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", "isasync": false, - "name": "updateIsoPermissions", + "name": "addNetworkDevice", "params": [ { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "parameters for network device", "length": 255, - "name": "accounts", + "name": "networkdeviceparameterlist", "required": false, - "type": "list" + "type": "map" }, { - "description": "permission operator (add, remove, reset)", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "op", + "name": "networkdevicetype", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the network device", + "name": "id", + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ] + }, + { + "description": "Restarts a VPC", + "isasync": true, + "name": "restartVPC", + "params": [ + { + "description": "Turn a single VPC into a redundant one.", "length": 255, - "name": "isextractable", + "name": "makeredundant", "required": false, "type": "boolean" }, { - "description": "the template ID", + "description": "the id of the VPC", "length": 255, "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createVPC,listVPCs,updateVPC", "required": true, "type": "uuid" }, { - "description": "true for featured template/iso, false otherwise", + "description": "If cleanup old network elements", "length": 255, - "name": "isfeatured", + "name": "cleanup", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "activateProject", - "required": false, - "type": "list" - }, - { - "description": "true for public template/iso, false for private templates/isos", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "ispublic", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" } ], @@ -122273,11 +128231,8 @@ "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", @@ -122288,324 +128243,426 @@ "name": "success", "type": "boolean" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Registers an existing template into the CloudStack cloud.", + "description": "Configure a quota email template", "isasync": false, - "name": "registerTemplate", + "name": "quotaConfigureEmail", "params": [ { - "description": "true if this template requires HVM", + "description": "Account ID for which to configure quota template email or min balance", "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": true, + "type": "uuid" }, { - "description": "Register template for the project", + "description": "Quota email template name which should be configured", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "templatename", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "New quota account min balance", "length": 255, - "name": "sshkeyenabled", + "name": "minbalance", "required": false, - "type": "boolean" + "type": "double" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "If the quota email template should be enabled", "length": 255, - "name": "templatetype", + "name": "enable", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" }, + {}, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "Whether the template is enabled.", + "name": "enabled", + "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "The template's name.", + "name": "templatename", "type": "string" }, { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The configured account's id.", + "name": "account", "type": "string" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ], + "since": "4.20.0.0" + }, + { + "description": "adds a baremetal dhcp server", + "isasync": true, + "name": "addBaremetalDhcp", + "params": [ { - "description": "32 or 64 bits support. 64 by default", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "format", + "name": "url", "required": true, "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "Type of dhcp device", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "dhcpservertype", + "required": true, + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the Physical Network ID", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "checksum", - "required": false, + "name": "password", + "required": true, + "type": "string" + } + ], + "related": "listBaremetalDhcp", + "response": [ + { + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, + {}, { - "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": "name of the provider", + "name": "provider", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "url", + "name": "url", + "type": "string" + } + ] + }, + { + "description": "delete Tungsten-Fabric application policy set", + "isasync": true, + "name": "deleteTungstenFabricApplicationPolicySet", + "params": [ + { + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", - "required": false, - "type": "list" + "name": "applicationpolicysetuuid", + "required": true, + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "the ID of zone", "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "zoneid", + "related": "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 tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "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": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Copies a snapshot from one zone to another.", + "isasync": true, + "name": "copySnapshot", + "params": [ { - "description": "the ID of the zone the template is to be hosted on", + "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": "zoneid", - "related": "createZone,listZones", + "name": "destzoneids", + "related": "listZones", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the ID of the snapshot.", "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "name": "id", + "related": "copySnapshot,listSnapshots", + "required": true, + "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "The ID of the zone the snapshot is being copied to.", "length": 255, - "name": "account", + "name": "destzoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "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": "directdownload", + "name": "sourcezoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "listSnapshots", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, + {}, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "name of the snapshot", + "name": "name", "type": "string" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 ID of the zone for this template", - "name": "zoneid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { @@ -122614,2050 +128671,1792 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds Traffic Monitor Host for Direct Network Usage", + "isasync": false, + "name": "addTrafficMonitor", + "params": [ + { + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "Zone in which to add the external firewall appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Traffic going into the listed zones will not be metered", + "length": 255, + "name": "excludezones", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "Lists user accounts", + "isasync": false, + "name": "listUsers", + "params": [ { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "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": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "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", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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 processor bit size", - "name": "bits", - "type": "int" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "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": "flag to display the resource icon for users", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers", + "required": false, + "type": "uuid" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "List users by state of the user account.", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "List user by the username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Deletes VPC offering", - "isasync": true, - "name": "deleteVPCOffering", - "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 VPC offering", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" } ], + "related": "disableUser,getUser", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + {}, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, {}, { "description": "the 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 account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user state", + "name": "state", + "type": "string" } ] }, { - "description": "List VNF appliance owned by the account.", + "description": "Updates a VLAN IP range.", "isasync": false, - "name": "listVnfAppliances", + "name": "updateVlanIpRange", "params": [ { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the ending IP address in the VLAN IP range", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "endip", "required": false, - "since": "4.4", - "type": "list" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the gateway of the IPv6 network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "ip6gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "state", + "name": "netmask", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "keyword", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "list vms by template", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "ip6cidr", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "name", + "name": "startip", "required": false, "type": "string" }, { - "description": "list by network id", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "gateway", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "haenable", + "name": "forsystemvms", "required": false, - "since": "4.15", "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "autoscalevmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "since": "4.18.0", + "name": "id", + "related": "updateVlanIpRange", + "required": true, "type": "uuid" }, { - "description": "", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "page", + "name": "startipv6", "required": false, - "type": "integer" + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", - "length": 255, - "name": "userid", - "related": "createUser,getUser", - "required": false, - "type": "uuid" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" }, { - "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "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 Pod ID for the VLAN IP range", + "name": "podid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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", + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the project id of the vlan range", "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, + {}, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "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": "the group ID", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + } + ], + "since": "4.16.0" + }, + { + "description": "Lists resource limits.", + "isasync": false, + "name": "listResourceLimits", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "groupid", - "related": "createInstanceGroup", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "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": "list by the service offering", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "account", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Lists resource limits by ID.", "length": 255, - "name": "isrecursive", + "name": "id", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the security group ID", + "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": "securitygroupid", - "related": "", + "name": "resourcetypename", "required": false, - "since": "4.15", - "type": "uuid" + "type": "string" }, { - "description": "list vms by iso", + "description": "Tag for the resource type", "length": 255, - "name": "isoid", + "name": "tag", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "the availability zone ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "", "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,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list vms by vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "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,listVnfAppliances,importUnmanagedInstance,importVm", + "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" + } + ] + }, + { + "description": "Disables a user account", + "isasync": true, + "name": "disableUser", + "params": [ + { + "description": "Disables user by user ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser", + "required": true, + "type": "uuid" + } + ], + "related": "getUser", + "response": [ + { + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + {}, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - } - ], - "type": "set" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the user lastname", + "name": "lastname", "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ] + }, + { + "description": "Lists all available ISO files.", + "isasync": false, + "name": "listIsos", + "params": [ + { + "description": "true if the ISO is publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the 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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the 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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "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" - } - ], - "type": "set" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "If set to true, list only unique isos across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "listSwifts", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "flag to display the resource image for the isos", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, + { + "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "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 ISO by ID", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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 host for the virtual machine", - "name": "hostid", + "description": "show removed ISOs as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "true if this ISO is ready to be deployed", + "length": 255, + "name": "isready", + "required": false, + "type": "boolean" + }, + { + "description": "list all ISOs by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "length": 255, + "name": "isofilter", + "required": false, "type": "string" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the template ID", "name": "id", "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "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 type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "checksum of the template", + "name": "checksum", "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 id to which the template belongs", + "name": "accountid", + "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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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 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 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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "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" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the template display text", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "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 group name of the virtual machine", - "name": "group", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, - {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "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 ISO attached to the virtual machine", - "name": "isoid", + "description": "the project name of the template", + "name": "project", "type": "string" } - ], - "since": "4.19.1" + ] }, { - "description": "Adds stratosphere ssp server", + "description": "Lists autoscale policies.", "isasync": false, - "name": "addStratosphereSsp", + "name": "listAutoScalePolicies", "params": [ { - "description": "stratosphere ssp api password", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "password", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "the zone ID", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "vmgroupid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "stratosphere ssp server url", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, - "name": "url", - "required": true, + "name": "action", + "required": false, "type": "string" }, { - "description": "stratosphere ssp api name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "stratosphere ssp api username", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "username", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "stratosphere ssp tenant 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": "tenantuuid", + "name": "listall", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "type": "boolean" + }, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, - {}, { - "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": "zone which this ssp controls", - "name": "zoneid", - "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", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, - {}, { - "description": "url of ssp endpoint", - "name": "url", - "type": "string" - } - ] - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACL", - "params": [ - { - "description": "the ID of the network ACL", + "description": "the ID of the condition of the policy", "length": 255, - "name": "id", - "related": "moveNetworkAclItem", - "required": true, + "name": "conditionid", + "related": "", + "required": false, "type": "uuid" } ], + "related": "", "response": [ - {}, + { + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" + }, + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, { "description": "the UUID 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 domain name of the autoscale policy", + "name": "domain", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "Creates a storage pool.", - "isasync": false, - "name": "createStoragePool", - "params": [ - { - "description": "the details for the storage pool", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" }, { - "description": "the name for the storage pool", - "length": 255, - "name": "name", - "required": true, + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": true, - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the storage provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "length": 255, - "name": "istagarule", - "required": false, - "type": "boolean" - }, - { - "description": "the cluster ID for the storage pool", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": false, + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" - }, + } + ] + }, + { + "description": "Dedicates an existing IPv4 subnet for a zone to an account or a domain.", + "isasync": true, + "name": "dedicateIpv4SubnetForZone", + "params": [ { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "hypervisor", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the tags for the storage pool", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "tags", + "name": "account", "required": false, "type": "string" }, { - "description": "whether the storage should be managed by CloudStack", + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, - "name": "managed", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the Pod ID for the storage pool", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "id", + "related": "dedicateIpv4SubnetForZone", + "required": true, "type": "uuid" } ], - "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", + "related": "", "response": [ - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the storage pool path", - "name": "path", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", + "params": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 hypervisor type of the storage pool", - "name": "hypervisor", + "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": "page", + "required": false, "type": "integer" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the storage pool type", - "name": "type", - "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the disk offering of the shared filesystem", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID of the storage pool", + "description": "the ID of the availability zone", + "length": 255, "name": "zoneid", - "type": "string" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - } - ] - }, - { - "description": "Lists storage pools available for migration of a volume.", - "isasync": false, - "name": "findStoragePoolsForMigration", - "params": [ { "description": "", "length": 255, @@ -124666,160 +130465,332 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the shared filesystem", "length": 255, - "name": "keyword", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the volume", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, "type": "uuid" }, { - "description": "", + "description": "the name of the shared filesystem", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" } ], - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "related": "changeSharedFileSystemDiskOffering", "response": [ { - "description": "whether this pool is managed or not", - "name": "managed", + "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 Zone name of the storage pool", - "name": "zonename", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the 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": "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the 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": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { @@ -124828,483 +130799,384 @@ "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "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 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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "List Autonomous Systems Number Ranges", - "isasync": false, - "name": "listASNRanges", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, + {}, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" + "description": "description of the shared filesystem", + "name": "description", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Created date", - "name": "created", - "type": "date" + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the AS Number Range", - "name": "id", + "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": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "End AS Number", - "name": "endasn", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, - {}, - {}, { - "description": "Start AS Number", - "name": "startasn", - "type": "long" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" } ], "since": "4.20.0" }, { - "description": "Adds an OpenDyalight controler", + "description": "adds baremetal rack configuration text", "isasync": true, - "name": "addOpenDaylightController", + "name": "addBaremetalRct", "params": [ { - "description": "Credential to access the OpenDaylight API", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Username to access the OpenDaylight API", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "Api URL of the OpenDaylight Controller.", + "description": "http url to baremetal RCT configuration", "length": 255, - "name": "url", + "name": "baremetalrcturl", "required": true, - "type": "string" + "type": "object" } ], "related": "", "response": [ { - "description": "the url of the controller api", - "name": "url", - "type": "string" - }, - { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "id of rct", + "name": "id", "type": "string" }, {}, - { - "description": "the name assigned to the controller", - "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", + "description": "url", + "name": "url", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { - "description": "Creates a Zone.", + "description": "Updates a role", "isasync": false, - "name": "createZone", + "name": "updateRole", "params": [ { - "description": "network type of the zone, can be Basic or Advanced", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "networktype", - "required": true, + "name": "type", + "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone", + "description": "creates a role with this unique name", "length": 255, - "name": "domain", + "name": "name", "required": false, "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "The description of the role", "length": 255, - "name": "ip6dns2", + "name": "description", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "internaldns1", - "required": true, - "type": "string" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the name of the Zone", + "description": "ID of the role", "length": 255, - "name": "name", + "name": "id", + "related": "listRoles,updateRole", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "The description of the role", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "description", "required": false, - "type": "uuid" + "type": "string" + } + ], + "related": "listRoles", + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the first DNS for the Zone", - "length": 255, - "name": "dns1", - "required": true, + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "length": 255, - "name": "internaldns2", - "required": false, + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "description": "the name of the role", + "name": "name", + "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "length": 255, - "name": "guestcidraddress", - "required": false, + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "true if the zone is an edge zone, false otherwise", - "length": 255, - "name": "isedge", - "required": false, - "since": "4.18.0", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", "type": "boolean" }, { - "description": "the second DNS for the Zone", + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists remote access vpns", + "isasync": false, + "name": "listRemoteAccessVpns", + "params": [ + { + "description": "", "length": 255, - "name": "dns2", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "", "length": 255, - "name": "securitygroupenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "ip6dns1", + "name": "id", + "related": "listRemoteAccessVpns", "required": false, - "type": "string" - } - ], - "related": "listZones", - "response": [ - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "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": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "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 maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "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": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Zone ID", - "name": "zoneid", - "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 Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "Zone description", - "name": "description", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -125313,183 +131185,138 @@ "type": "integer" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, - { - "description": "Zone Token", - "name": "zonetoken", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "is vpn for display to the regular user", + "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" } ] }, { - "description": "Creates a Storage network IP range.", - "isasync": true, - "name": "createStorageNetworkIpRange", + "description": "Deletes a Webhook", + "isasync": false, + "name": "deleteWebhook", "params": [ { - "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" - }, - { - "description": "UUID of pod where the ip range belongs to", + "description": "The ID of the Webhook", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "createWebhook", "required": true, "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": true, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the ending IP address", - "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 for storage network", - "length": 255, - "name": "gateway", - "required": true, - "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 network ACL", + "isasync": true, + "name": "deleteNetworkACLList", + "params": [ { - "description": "the netmask for storage network", + "description": "the ID of the network ACL", "length": 255, - "name": "netmask", + "name": "id", + "related": "createNetworkACLList", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", "response": [ { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -125497,149 +131324,166 @@ "name": "jobstatus", "type": "integer" }, + {} + ] + }, + { + "description": "Removes secondary IP from the NIC.", + "isasync": true, + "name": "removeIpFromNic", + "params": [ { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" - }, - { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" - }, + "description": "the ID of the secondary ip address to nic", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID 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": "Lists all children domains belonging to a specified domain", - "isasync": false, - "name": "listDomainChildren", + "description": "Creates a system virtual-machine that implements network services", + "isasync": true, + "name": "createServiceInstance", "params": [ { - "description": "flag to display the resource icon for domains", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "The name of the service instance", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "Availability zone for the service instance", "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", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "list children domains by name", + "description": "The left (inside) network for service instance", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, { - "description": "list children domain by parent domain ID.", + "description": "Project ID for the service instance", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "page", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "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": "integer" + "type": "uuid" } ], - "related": "listDomains", + "related": "", "response": [ { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the name of the domain", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "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 projects the domain can own", - "name": "projectlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -125647,483 +131491,476 @@ "type": "integer" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "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 ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "startSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "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 hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "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 total number of templates which have been created by this domain", - "name": "templatetotal", - "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 path of the domain", - "name": "path", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the network domain", + "description": "the network domain for the system VM", "name": "networkdomain", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "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 total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" - } - ] - }, - { - "description": "Returns an encrypted password for the VM", - "isasync": false, - "name": "getVMPassword", - "params": [ - { - "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,listVnfAppliances,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - {}, + }, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" } ] }, { - "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", - "isasync": true, - "name": "assignToGlobalLoadBalancerRule", + "description": "Registers an existing VNF template into the CloudStack cloud. ", + "isasync": false, + "name": "registerVnfTemplate", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "gslblbruleweightsmap", + "name": "isfeatured", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", - "length": 255, - "name": "loadbalancerrulelist", - "related": "", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", "required": true, - "type": "list" - } - ], - "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 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": "the 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 template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" - } - ] - }, - { - "description": "Configures an ovs element.", - "isasync": true, - "name": "configureOvsElement", - "params": [ + }, { - "description": "the ID of the ovs provider", + "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": "id", - "related": "configureOvsElement", - "required": true, + "name": "ostypeid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "Enabled/Disabled the service provider", + "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": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" + "name": "vnfdetails", + "required": false, + "type": "map" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 account associated with the provider", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", - "type": "string" + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "length": 255, + "name": "zoneids", + "related": "listZones", + "required": false, + "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "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 physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, - {} - ] - }, - { - "description": "Adds S3 Image Store", - "isasync": false, - "name": "addImageStoreS3", - "params": [ { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "s3signer", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "S3 endpoint", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "endpoint", + "name": "format", "required": true, "type": "string" }, { - "description": "Connection timeout (milliseconds)", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "connectiontimeout", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Maximum number of times to retry on error", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "maxerrorretry", + "name": "isextractable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "S3 access key", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "accesskey", - "required": true, - "type": "string" - }, - { - "description": "Use HTTPS instead of HTTP", - "length": 255, - "name": "usehttps", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "Socket timeout (milliseconds)", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "sockettimeout", + "name": "deployasis", "required": false, - "type": "integer" + "since": "4.15.1", + "type": "boolean" }, { - "description": "S3 secret key", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "secretkey", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { - "description": "Whether TCP keep-alive is used", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "usetcpkeepalive", + "name": "directdownload", "required": false, "type": "boolean" }, { - "description": "Connection TTL (milliseconds)", + "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": "connectionttl", + "name": "vnfnics", "required": false, - "type": "integer" + "type": "map" }, { - "description": "Name of the storage bucket", + "description": "the target hypervisor for the template", "length": 255, - "name": "bucket", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "the name of the template", + "length": 255, + "name": "name", "required": true, "type": "string" + }, + { + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "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" } ], - "related": "listImageStores", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -126132,35 +131969,49 @@ "type": "integer" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -126168,1684 +132019,1162 @@ "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" - } - ], - "since": "4.7.0" - }, - { - "description": "Upload a certificate for HTTPS direct template download on KVM hosts", - "isasync": false, - "name": "uploadTemplateDirectDownloadCertificate", - "params": [ + }, { - "description": "(optional) the host ID to upload certificate", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "Zone to upload certificate", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "Name for the uploaded certificate", - "length": 255, + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the template name", "name": "name", - "required": true, "type": "string" }, { - "description": "Hypervisor type", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", + "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "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 direct download certificate subject", - "name": "subject", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Import unmanaged virtual machine from a given cluster.", - "isasync": true, - "name": "importUnmanagedInstance", - "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, + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "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": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists VM stats", + "isasync": false, + "name": "listVirtualMachinesUsageHistory", + "params": [ + { + "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, - "name": "nicipaddresslist", + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "map" + "type": "list" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "", "length": 255, - "name": "nicnetworklist", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the host name of the instance", + "description": "the ID of the virtual machine.", "length": 255, - "name": "hostname", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the service offering for the virtual machine", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "import instance for the project", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "forced", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "import instance to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "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,listVnfAppliances,importVm", + "related": "listSystemVmsUsageHistory", "response": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the virtual machine", + "name": "name", "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 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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, + {} + ], + "since": "4.17" + }, + { + "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", + "params": [ { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "host ID", + "length": 255, + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "reconnectHost", + "response": [ + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the OS category name of the host", + "name": "oscategoryname", "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 last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "events available for the host", + "name": "events", "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 host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the 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": "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 name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], "type": "list" - }, - { - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "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 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", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the hypervisor version", + "name": "hypervisorversion", "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "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": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + } + ], + "since": "4.16.0.0" + }, + { + "description": "Creates a Kubernetes cluster", + "isasync": true, + "name": "createKubernetesCluster", + "params": [ { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of 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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - } - ], - "type": "set" + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "password for the docker image private registry", + "length": 255, + "name": "dockerregistrypassword", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "number of Kubernetes cluster control nodes, default is 1", + "length": 255, + "name": "controlnodes", + "required": false, + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "root disk size in GB for each node", + "length": 255, + "name": "noderootdisksize", + "required": false, "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "length": 255, + "name": "masternodes", + "required": false, + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "name for the Kubernetes cluster", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Deploy cluster for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "Lists System VM stats", - "isasync": false, - "name": "listSystemVmsUsageHistory", - "params": [ { - "description": "", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "number of Kubernetes cluster worker nodes", "length": 255, - "name": "startdate", + "name": "size", "required": false, - "type": "date" + "type": "long" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "Kubernetes version with which cluster to be launched", "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,listVnfAppliances,importVm", + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "keyword", + "name": "keypair", "required": false, "type": "string" }, { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "user name for the docker image private registry", "length": 255, - "name": "name", + "name": "dockerregistryusername", "required": false, "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "enddate", + "name": "externalloadbalanceripaddress", "required": false, - "type": "date" + "type": "string" }, { - "description": "the ID of the system VM.", + "description": "URL for the docker image private registry", "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,listVnfAppliances,importVm", + "name": "dockerregistryurl", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "startKubernetesCluster", "response": [ { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "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 zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" + }, + { + "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": "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", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the name of the virtual machine", + "description": "the name of the Kubernetes cluster", "name": "name", "type": "string" }, - {}, - {} - ], - "since": "4.18.0" - }, - { - "description": "Deletes a IPv6 firewall rule", - "isasync": true, - "name": "deleteIpv6FirewallRule", - "params": [ { - "description": "the ID of the IPv6 firewall rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Creates a physical network", - "isasync": true, - "name": "createPhysicalNetwork", - "params": [ + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" + }, { - "description": "the VLAN for the physical network", - "length": 255, - "name": "vlan", - "required": false, + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", "type": "list" }, + {}, { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the physical network", - "length": 255, - "name": "name", - "required": true, + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "domain ID of the account owning a physical network", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", - "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", - "length": 255, - "name": "broadcastdomainrange", - "required": false, + "description": "keypair details", + "name": "keypair", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "state of the physical network", - "name": "state", - "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": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "name of the physical network", - "name": "name", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "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 size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists autoscale vm groups.", + "description": "List a storage network IP range.", "isasync": false, - "name": "listAutoScaleVmGroups", + "name": "listStorageNetworkIpRange", "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 autoscale vm group", - "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the loadbalancer", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "lbruleid", - "related": "", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, "type": "uuid" }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "", "length": 255, @@ -127853,14 +133182,6 @@ "required": false, "type": "integer" }, - { - "description": "the ID of the profile", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -127869,570 +133190,630 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, + "type": "uuid" + } + ], + "related": "createStorageNetworkIpRange", + "response": [ + { + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "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": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", - "related": "", - "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 autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the public ip address id", - "name": "publicipid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - {}, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "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.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the network uuid of storage network IP range", + "name": "networkid", "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", + "required": true, + "type": "uuid" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the account owning the vm group", - "name": "account", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the vm group", + "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public port", - "name": "publicport", + "description": "the domain associated with the provider", + "name": "domain", "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 autoscale vm group ID", + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {} + ] + }, + { + "description": "Enables HA for a host", + "isasync": true, + "name": "enableHAForHost", + "params": [ { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" - }, + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "disableHAForHost", + "response": [ { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "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", + "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 autoscale vm group ", - "name": "name", + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "operation status", + "name": "status", + "type": "boolean" } - ] + ], + "since": "4.11" }, { - "description": "Creates a firewall rule for a given IP address", + "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": "createFirewallRule", + "name": "updateVMAffinityGroup", "params": [ { - "description": "type of the ICMP message being sent", + "description": "The ID of the virtual machine", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "type of firewallrule: system/user", + "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": "type", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "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": "cidrlist", + "name": "affinitygroupnames", + "related": "", "required": false, "type": "list" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, + "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 IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "updateEgressFirewallRule", - "response": [ + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the ID of the 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 rule", - "name": "state", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "type": "set" }, + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, - {}, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the project name of the vm", + "name": "project", "type": "string" - } - ] - }, - { - "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": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, - { - "description": "Arbitrary volume size", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", - "length": 255, - "name": "virtualmachineid", - "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,listVnfAppliances,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "min iops", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "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, + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the disk volume", - "length": 255, + "description": "the name of the virtual machine", "name": "name", - "required": false, "type": "string" }, { - "description": "an optional field, whether to display the volume to the end user or not.", - "length": 255, - "name": "displayvolume", - "required": false, + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "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": "the project associated with the volume. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "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", @@ -128440,108 +133821,23 @@ "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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" }, { @@ -128550,416 +133846,525 @@ "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - {}, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the state of the disk volume", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the 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": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 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" } ], "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, {}, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "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 format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "List virtual machine snapshot by conditions", - "isasync": false, - "name": "listVMSnapshot", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" }, { - "description": "lists snapshot by snapshot name or display name", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the vm", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", - "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "state of the virtual machine snapshot", - "length": 255, - "name": "state", - "required": false, - "type": "string" - } - ], - "related": "createVMSnapshot", - "response": [ - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, - { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -128968,13 +134373,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -128983,113 +134388,118 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, + {}, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "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", @@ -129097,383 +134507,334 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + } + ] + }, + { + "description": "Registers NCC Service Package", + "isasync": false, + "name": "registerNetscalerServicePackage", + "params": [ + { + "description": "Name of the service Package.", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the description of the vm snapshot", + "description": "Description of Service Package", + "length": 255, "name": "description", + "required": true, "type": "string" } ], - "since": "4.2.0" + "related": "listRegisteredServicePackages", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Service Package Name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" + }, + { + "description": "Description of Service Package", + "name": "description", + "type": "string" + }, + {}, + {} + ] }, { - "description": "Updates a Pod.", + "description": "Updates a Webhook", "isasync": false, - "name": "updatePod", + "name": "updateWebhook", "params": [ { - "description": "the ID of the Pod", + "description": "Payload URL of the Webhook", "length": 255, - "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "payloadurl", + "required": false, + "type": "string" }, { - "description": "the name of the Pod", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "name", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "The ID of the Webhook", "length": 255, - "name": "allocationstate", + "name": "id", + "related": "createWebhook", + "required": true, + "type": "uuid" + }, + { + "description": "State of the Webhook", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "Description for the Webhook", "length": 255, - "name": "startip", + "name": "description", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "Name for the Webhook", "length": 255, - "name": "netmask", + "name": "name", "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "Secret key of the Webhook", "length": 255, - "name": "gateway", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "Scope of the Webhook", "length": 255, - "name": "endip", + "name": "scope", "required": false, "type": "string" } ], - "related": "createManagementNetworkIpRange", "response": [ { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Add +-credits to an account", + "isasync": false, + "name": "quotaCredits", + "params": [ + { + "description": "Domain for which quota credits need to be added", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "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 use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "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 tag for the capacity type", - "name": "tag", - "type": "string" - } - ], - "type": "list" + "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", + "length": 255, + "name": "quota_enforce", + "required": false, + "type": "boolean" }, - {}, { - "description": "the name of the Pod", - "name": "name", + "description": "Account Id for which quota credits need to be added", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" + "description": "Value of the credits to be added+, subtracted-", + "length": 255, + "name": "value", + "required": true, + "type": "double" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "Minimum balance threshold of the account", + "length": 255, + "name": "min_balance", + "required": false, + "type": "double" + } + ], + "related": "", + "response": [ + { + "description": "the credit deposited", + "name": "credits", + "type": "bigdecimal" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "currency", + "name": "currency", "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 account name of the admin who updated the credits", + "name": "updated_on", + "type": "date" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the UUID of the latest async job acting on 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 Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the user name of the admin who updated the credits", + "name": "updated_by", "type": "string" } - ] + ], + "since": "4.7.0" }, { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", - "isasync": true, - "name": "moveNetworkAclItem", + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "customid", + "name": "provider", "required": false, - "since": "4.4", + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Private key for the certificate", + "name": "privatekey", "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 client certificate", + "name": "certificate", "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, + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, + {}, { - "description": "The ID of the network ACL rule that is being moved to a new position.", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "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": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "description": "the host to provision the certificate", "length": 255, - "name": "previousaclruleid", - "required": false, - "type": "string" + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "list" + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the name of the host", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { @@ -129481,279 +134842,315 @@ "name": "jobstatus", "type": "integer" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "updateProjectRole", + "params": [ { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "creates a project role with this unique name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, + { + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", + "required": true, + "type": "uuid" + }, + { + "description": "The description of the Project role", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the id of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the starting port of ACL's port range", - "name": "startport", - "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": "Add a new Ldap Configuration", + "isasync": false, + "name": "addLdapConfiguration", + "params": [ + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "Port", + "length": 255, + "name": "port", + "required": true, "type": "integer" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the state of the rule", - "name": "state", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, + {}, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "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": "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" + } + ], + "since": "4.2.0" }, { - "description": "Attaches an ISO to a virtual machine.", + "description": "create Tungsten-Fabric address group", "isasync": true, - "name": "attachIso", + "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "the ID of the virtual machine", + "description": "Tungsten-Fabric ip prefix length", "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,listVnfAppliances,importVm", + "name": "ipprefixlen", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the ISO file", + "description": "Tungsten-Fabric address group name", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "ipprefix", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "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,listVnfAppliances,importVm", + "related": "", "response": [ { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the 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": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, + {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" - }, + } + ] + }, + { + "description": "Lists BigSwitch BCF Controller devices", + "isasync": false, + "name": "listBigSwitchBcfDevices", + "params": [ { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "bigswitch BCF controller device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": false, + "type": "uuid" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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", + "description": "NAT support", + "name": "nat", "type": "boolean" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -129761,169 +135158,216 @@ "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the controller password", + "name": "password", "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "lists registered service packages", + "isasync": false, + "name": "listRegisteredServicePackages", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Description of Service Package", + "name": "description", "type": "string" }, + {}, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": " 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": "ssh key-pairs", - "name": "keypairs", + "description": "Service Package Name", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Change Disk offering of a Shared FileSystem", + "isasync": true, + "name": "changeSharedFileSystemDiskOffering", + "params": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the size of the shared filesystem in GiB", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the disk offering to use for the underlying storage", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, + "type": "uuid" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "name of the shared filesystem", + "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": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "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": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -129935,18 +135379,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -129955,13 +135399,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -129970,147 +135419,95 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the virtual machine", + "description": "the state of the shared filesystem", "name": "state", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, - {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", + "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -130119,28 +135516,13 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the 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": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -130154,38 +135536,58 @@ "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "the ip address of the nic", + "name": "ipaddress", + "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 broadcast uri of the nic", "name": "broadcasturi", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the 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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -130194,819 +135596,561 @@ "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the 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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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": "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "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 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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" - }, - { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Enables static NAT for given IP address", + "isasync": false, + "name": "enableStaticNat", + "params": [ + { + "description": "the ID of the virtual machine for enabling static NAT feature", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the public IP address ID for which static NAT feature is being enabled", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "The network of the VM the static NAT will be enabled for. Required when public IP address is not associated with any guest network yet (VPC case)", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, "type": "string" - }, + } + ], + "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 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 user's ID who deployed the virtual machine", - "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" - } + }, + {} ] }, { - "description": "Disassociates an IP address from the account.", - "isasync": true, - "name": "disassociateIpAddress", + "description": "Deletes a Zone.", + "isasync": false, + "name": "deleteZone", "params": [ { - "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", + "description": "the ID of the Zone", "length": 255, - "name": "ipaddress", - "required": false, - "since": "4.19.0", + "name": "id", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", + "description": "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": "Expunge a Shared FileSystem by id", + "isasync": true, + "name": "expungeSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem to expunge", "length": 255, "name": "id", - "related": "associateIpAddress,listPublicIpAddresses", + "related": "", "required": false, "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} - ] + } + ], + "since": "4.20.0" }, { - "description": "list baremetal dhcp servers", + "description": "upload an existing template into the CloudStack cloud. ", "isasync": false, - "name": "listBaremetalDhcp", + "name": "getUploadParamsForTemplate", "params": [ { - "description": "", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "pagesize", + "name": "bits", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "format", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Type of DHCP device", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "dhcpservertype", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "DHCP server device ID", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "id", + "name": "ispublic", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "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": "page", + "name": "ostypeid", + "related": "", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "type": "uuid" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the display text of the template. This is usually used for display purposes.", + "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": "url", - "name": "url", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, "type": "string" }, - {}, - {} - ] - }, - { - "description": "Puts storage pool into maintenance state", - "isasync": true, - "name": "enableStorageMaintenance", - "params": [ { - "description": "Primary storage ID", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" - } - ], - "related": "cancelStorageMaintenance", - "response": [ - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "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 storage pool capabilities", - "name": "storagecapabilities", + "description": "Template details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, "type": "map" }, - {}, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, "type": "boolean" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "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": "the storage pool type", - "name": "type", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "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": "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 storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "true if the template type is routing i.e., if template is used to deploy router", + "length": 255, + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" - }, + } + ], + "related": "getUploadParamsForIso", + "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, + {}, + {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the storage pool path", - "name": "path", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes snapshot policies for the account.", + "isasync": false, + "name": "deleteSnapshotPolicies", + "params": [ { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the Id of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, + "description": "list of snapshots policy IDs separated by comma", + "length": 255, + "name": "ids", + "related": "updateSnapshotPolicy", + "required": false, + "type": "list" + } + ], + "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the 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": "the tags for the storage pool", - "name": "tags", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" - } - ] - }, - { - "description": "Removes an existing secondary storage selector.", - "isasync": false, - "name": "removeSecondaryStorageSelector", - "params": [ + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { - "description": "The unique identifier of the secondary storage selector to be removed.", + "description": "", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "", "response": [ + { + "description": "network traffic type", + "name": "traffictype", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -131014,13 +136158,8 @@ "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": "implementor of network traffic type", + "name": "traffictypeimplementor", "type": "string" }, {}, @@ -131030,386 +136169,527 @@ "type": "integer" } ], - "since": "4.19.0" + "since": "3.0.0" }, { - "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "description": "list the db hosts and statistics", "isasync": false, - "name": "ldapRemove", + "name": "listDbMetrics", "params": [], "related": "", "response": [ { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", - "type": "string" + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" }, - {}, { - "description": "DN password", - "name": "bindpass", + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" + }, + { + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" + }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + { + "description": "the version of the currently running DB", + "name": "version", "type": "string" }, + { + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", - "type": "string" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" + } + ], + "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", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "3.0.1" + "since": "4.2.0" }, { - "description": "Creates a user for an account that already exists", + "description": "Lists autoscale vm profiles.", "isasync": false, - "name": "createUser", + "name": "listAutoScaleVmProfiles", "params": [ { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "", "length": 255, - "name": "userid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lastname", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "lastname", - "required": true, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", - "required": true, + "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "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": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "timezone", + "name": "otherdeployparams", "required": false, "type": "string" }, { - "description": "email", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "email", - "required": true, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "firstname", + "description": "", "length": 255, - "name": "firstname", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Unique username.", + "description": "list profiles by service offering id", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], - "related": "getUser", + "related": "", "response": [ { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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 time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" }, + {}, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user ID", - "name": "id", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "is profile for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the user", + "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, + {}, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, - {}, { - "description": "the account name of the user", - "name": "account", + "description": "the project name of the vm profile", + "name": "project", "type": "string" } ] }, { - "description": "lists all available apis on the server, provided by the Api Discovery plugin", - "isasync": false, - "name": "listApis", + "description": "Authorizes a particular ingress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "API name", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "name", + "name": "securitygroupname", + "required": false, + "type": "string" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "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": "protocol", "required": false, "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": "end port for this ingress rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "start port for this ingress rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, + { + "description": "an optional project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "user to security group mapping", + "length": 255, + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "length": 255, + "name": "securitygroupid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "description of the api", - "name": "description", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the name of the api command", - "name": "name", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, - {}, { - "description": "the list params the api accepts", - "name": "params", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "description of the api parameter", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "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": "the name of the api parameter", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, - {}, { - "description": "parameter type", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "description of the api response field", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "comma separated related apis", - "name": "related", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -131421,241 +136701,329 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + {}, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } - ], - "since": "4.1.0" + ] }, { - "description": "deletes baremetal rack configuration text", + "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", "isasync": true, - "name": "deleteBaremetalRct", + "name": "syncStoragePool", "params": [ { - "description": "RCT id", + "description": "Storage pool id", "length": 255, "name": "id", - "related": "", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": true, "type": "uuid" } ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "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": "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", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "public ip address id of the vpn gateway", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" } - ] + ], + "since": "4.15.1" }, { - "description": "Creates snapshot for a vm.", - "isasync": true, - "name": "createVMSnapshot", + "description": "Updates Bucket properties", + "isasync": false, + "name": "updateBucket", "params": [ { - "description": "The display name of the snapshot", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "name", + "name": "encryption", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The description of the snapshot", + "description": "The ID of the Bucket", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "snapshot memory if true", + "description": "Bucket Quota in GB", "length": 255, - "name": "snapshotmemory", + "name": "quota", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The ID of the vm", + "description": "Bucket Access Policy", "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,listVnfAppliances,importVm", - "required": true, - "type": "uuid" + "name": "policy", + "required": false, + "type": "string" }, { - "description": "quiesce vm if true", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "quiescevm", + "name": "versioning", "required": false, "type": "boolean" } ], - "related": "", "response": [ { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "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": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "integer" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The resource count", + "name": "resourcecount", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -131663,251 +137031,201 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "Tag for the resource", + "name": "tag", + "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "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 description of the vm snapshot", - "name": "description", + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the vpn", + "description": "the project id for which resource count's are updated", "name": "projectid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project name for which resource count's are updated", + "name": "project", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the domain name for which resource count's are updated", + "name": "domain", "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 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": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, + "description": "the domain ID for which resource count's are updated", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": "Lists dynamic roles in CloudStack", + "isasync": false, + "name": "listRoles", + "params": [ { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the vm snapshot", + "description": "List role by role name.", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "length": 255, + "name": "type", + "required": false, "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Adds detail for the Resource.", - "isasync": true, - "name": "addResourceDetail", - "params": [ + }, { - "description": "resource id to create the details for", + "description": "", "length": 255, - "name": "resourceid", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "pass false if you want this detail to be disabled for the regular user. True by default", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "fordisplay", + "name": "state", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "Map of (key/value pairs)", + "description": "List role by role ID.", "length": 255, - "name": "details", - "required": true, - "type": "map" + "name": "id", + "related": "listRoles", + "required": false, + "type": "uuid" }, { - "description": "type of the resource", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "", "response": [ + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on 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 role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the type of the role", + "name": "type", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the role", + "name": "state", "type": "string" - } - ] - }, - { - "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": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the description of the role", + "name": "description", "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.9.0" + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicy", + "params": [ { - "description": "the username of the vpn user.", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "username", + "name": "policyuuid", "required": false, "type": "string" }, { - "description": "The uuid of the Vpn user", + "description": "the ID of network", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the ID of ip address", "length": 255, - "name": "listall", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -131917,275 +137235,272 @@ "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of zone", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" } ], - "related": "addVpnUser", + "related": "", "response": [ { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the vpn userID", - "name": "id", - "type": "string" - }, - { - "description": "the account of the remote access vpn", - "name": "account", + "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": "the username of the vpn user", - "name": "username", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - } + {} ] }, { - "description": "Deletes an internal load balancer", + "description": "Download object at a specified path on an image store.", "isasync": true, - "name": "deleteLoadBalancer", + "name": "downloadImageStoreObject", "params": [ { - "description": "the ID of the Load Balancer", + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "id of the image store", "length": 255, "name": "id", - "related": "", + "related": "listSwifts", "required": true, "type": "uuid" } ], + "related": "extractSnapshot,extractTemplate", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of extracted object", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "type of the storage", + "name": "storagetype", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes an IP forwarding rule", - "isasync": true, - "name": "deleteIpForwardingRule", - "params": [ + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, { - "description": "the ID of the forwarding rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "", + "name": "resultstring", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, + { + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, - {} - ] - }, - { - "description": "Register a new userdata.", - "isasync": false, - "name": "registerUserData", - "params": [ + {}, { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "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, + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "comma separated list of variables declared in userdata content", - "length": 255, - "name": "params", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "Name of the userdata", - "length": 255, - "name": "name", - "required": true, + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Retrieves a cloud identifier.", + "isasync": false, + "name": "getCloudIdentifier", + "params": [ { - "description": "an optional project for the userdata", + "description": "the user ID for the cloud identifier", "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, + "name": "userid", + "related": "getUser", + "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the signed response for the cloud identifier", + "name": "signature", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 cloud identifier", + "name": "cloudidentifier", + "type": "string" } - ], - "since": "4.18" + ] }, { - "description": "Adds a Region", - "isasync": false, - "name": "addRegion", + "description": "Creates a load balancer stickiness policy ", + "isasync": true, + "name": "createLBStickinessPolicy", "params": [ { - "description": "Id of the Region", + "description": "name of the load balancer stickiness policy", "length": 255, - "name": "id", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Name of the region", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "name", - "required": true, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "Region service endpoint", + "description": "the ID of the load balancer rule", "length": 255, - "name": "endpoint", + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", + "length": 255, + "name": "methodname", "required": true, "type": "string" + }, + { + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "length": 255, + "name": "param", + "required": false, + "type": "map" } ], "related": "", "response": [ { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" - }, - { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -132193,59 +137508,25 @@ "type": "integer" }, { - "description": "the name of the region", - "name": "name", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - { - "description": "the end point of the region", - "name": "endpoint", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "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": "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": false, - "type": "date" - }, { - "description": "List events for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" }, - { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - } - ], - "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -132253,62 +137534,105 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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" + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Updates a role permission order", + "description": "Adds a Cisco Asa 1000v appliance", "isasync": false, - "name": "updateRolePermission", + "name": "addCiscoAsa1000vResource", "params": [ { - "description": "ID of the role", + "description": "the Physical Network ID", "length": 255, - "name": "roleid", + "name": "physicalnetworkid", "related": "", "required": true, "type": "uuid" }, { - "description": "Role permission rule id", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "ruleid", - "related": "", - "required": false, - "since": "4.11", - "type": "uuid" + "name": "hostname", + "required": true, + "type": "string" }, { - "description": "Rule permission, can be: allow or deny", + "description": "the Cluster ID", "length": 255, - "name": "permission", - "required": false, - "since": "4.11", - "type": "string" + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Nexus port profile associated with inside interface of ASA 1000v", "length": 255, - "name": "ruleorder", - "related": "", - "required": false, - "type": "list" + "name": "insideportprofile", + "required": true, + "type": "string" } ], + "related": "", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -132316,252 +137640,324 @@ }, {}, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.9.0" + {}, + {}, + {} + ] }, { - "description": "Returns a download URL for extracting a snapshot. It must be in the Backed Up state.", + "description": "Configures a Palo Alto firewall device", "isasync": true, - "name": "extractSnapshot", + "name": "configurePaloAltoFirewall", "params": [ { - "description": "the ID of the snapshot", + "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "id", - "related": "listSnapshots", - "required": true, - "since": "4.20.0", - "type": "uuid" + "name": "fwdevicecapacity", + "required": false, + "type": "long" }, { - "description": "the ID of the zone where the snapshot is located", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fwdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "required": true, - "since": "4.20.0", "type": "uuid" } ], - "related": "", + "related": "listPaloAltoFirewalls", "response": [ { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "device name", + "name": "fwdevicename", "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": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 status of the extraction", - "name": "status", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "List registered keypairs", - "isasync": false, - "name": "listSSHKeyPairs", + "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "isrecursive", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "A key pair name to look for", + "description": "the ending port of ACL", "length": 255, - "name": "name", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "type of the ICMP message being sent", "length": 255, - "name": "pagesize", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "scl entry action, allow or deny", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "action", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "listall", + "name": "cidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "A public key fingerprint to look for", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "fingerprint", + "name": "protocol", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "account", + "name": "partialupgrade", + "required": false, + "type": "boolean" + }, + { + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "length": 255, + "name": "traffictype", "required": false, "type": "string" }, { - "description": "the ID of the ssh keypair", + "description": "error code for this ICMP message", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "icmpcode", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "keyword", + "name": "number", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the network ACL item", "length": 255, - "name": "page", + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" + }, + { + "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" } ], - "related": "", + "related": "moveNetworkAclItem", "response": [ { - "description": "the owner of the keypair", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", - "type": "string" + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "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" + } + ], + "type": "list" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { @@ -132570,83 +137966,134 @@ "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" } ] }, { - "description": "Lists accounts and provides detailed account information for listed accounts", + "description": "List routers.", "isasync": false, - "name": "listAccounts", + "name": "listRouters", "params": [ { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "the Zone ID of the router", "length": 255, - "name": "state", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Tag for resource type to return usage", + "description": "the host ID of the router", "length": 255, - "name": "tag", + "name": "hostid", + "related": "reconnectHost", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "listall", + "name": "healthchecksfailed", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by network id", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "length": 255, + "name": "fetchhealthcheckresults", "required": false, + "since": "4.14", "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "List networks by VPC", "length": 255, - "name": "accounttype", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "the state of the router", "length": 255, - "name": "details", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "list account by account ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -132657,11 +138104,18 @@ "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "the name of the router", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "List by keyword", @@ -132671,9 +138125,24 @@ "type": "string" }, { - "description": "flag to display the resource icon for accounts", + "description": "the ID of the disk router", "length": 255, - "name": "showicon", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list virtual router elements by version", + "length": 255, + "name": "version", + "required": false, + "type": "string" + }, + { + "description": "if true is passed for this parameter, list only VPC routers", + "length": 255, + "name": "forvpc", "required": false, "type": "boolean" }, @@ -132685,334 +138154,448 @@ "type": "integer" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "the cluster ID of the router", "length": 255, - "name": "iscleanuprequired", + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list account by account name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the Pod ID of the router", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" } ], - "related": "enableAccount,listAccounts", + "related": "", "response": [ { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + {}, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the domain name of the user", - "name": "domain", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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 user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "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 user name", - "name": "username", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "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 timezone user was created in", - "name": "timezone", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - {}, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the account", - "name": "name", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the 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", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the version of template", + "name": "version", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -133021,916 +138604,715 @@ "type": "integer" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, + "description": "the state of the router", + "name": "state", + "type": "state" + } + ] + }, + { + "description": "list Tungsten-Fabric vm", + "isasync": false, + "name": "listTungstenFabricVm", + "params": [ { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the id of the account", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "description": "Tungsten-Fabric vm name", + "name": "name", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {}, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, { - "description": "Cancels maintenance for primary storage", + "description": "Deletes a Physical Network.", "isasync": true, - "name": "cancelStorageMaintenance", + "name": "deletePhysicalNetwork", "params": [ { - "description": "the primary storage ID", + "description": "the ID of the Physical network", "length": 255, "name": "id", - "related": "cancelStorageMaintenance", + "related": "", "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "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": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, - { - "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" }, - {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "add Tungsten-Fabric policy rule", + "isasync": true, + "name": "addTungstenFabricPolicyRule", + "params": [ { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "Tungsten-Fabric policy rule source end port", + "length": 255, + "name": "srcendport", + "required": true, + "type": "integer" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "Tungsten-Fabric policy rule source start port", + "length": 255, + "name": "srcstartport", + "required": true, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric policy rule destination ip prefix", + "length": 255, + "name": "destipprefix", + "required": true, "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "Tungsten-Fabric policy rule protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Tungsten-Fabric policy rule destination end port", + "length": 255, + "name": "destendport", + "required": true, + "type": "integer" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the storage pool type", - "name": "type", + "description": "Tungsten-Fabric policy rule destination network", + "length": 255, + "name": "destnetwork", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Tungsten-Fabric policy rule source ip prefix length", + "length": 255, + "name": "srcipprefixlen", + "required": true, + "type": "integer" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "Tungsten-Fabric policy rule destination ip prefix length", + "length": 255, + "name": "destipprefixlen", + "required": true, + "type": "integer" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "Tungsten-Fabric policy rule destination start port", + "length": 255, + "name": "deststartport", + "required": true, + "type": "integer" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Tungsten-Fabric policy rule direction", + "length": 255, + "name": "direction", + "required": true, + "type": "string" }, { - "description": "the Zone ID of the storage pool", + "description": "the ID of zone", + "length": 255, "name": "zoneid", - "type": "string" + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Tungsten-Fabric policy rule source ip prefix", + "length": 255, + "name": "srcipprefix", + "required": true, "type": "string" - } - ] - }, - { - "description": "Destroys a router.", - "isasync": true, - "name": "destroyRouter", - "params": [ + }, { - "description": "the ID of the router", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "id", - "related": "destroyRouter", + "name": "action", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the public IP address for the router", - "name": "publicip", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "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": "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 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 the nic", - "name": "gateway", - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "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 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 traffic type of the nic", - "name": "traffictype", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - } - ], - "type": "set" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "the name of the router", - "name": "name", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, - {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, + {} + ] + }, + { + "description": "Creates a Webhook", + "isasync": false, + "name": "createWebhook", + "params": [ { - "description": "the state of the router", - "name": "state", - "type": "state" + "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 domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "Project for the Webhook", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "Description for the Webhook", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "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": "the version of scripts", - "name": "scriptsversion", + "description": "An optional account for the Webhook. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "Name for the Webhook", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "Scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Payload URL of the Webhook", + "length": 255, + "name": "payloadurl", + "required": true, "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "State of the Webhook", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "Secret key of the Webhook", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "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 guest MAC address for the router", - "name": "guestmacaddress", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Removes vpn user", + "isasync": true, + "name": "removeVpnUser", + "params": [ { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "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": "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 Pod ID for the router", - "name": "podid", + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "remove vpn user from the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + {}, { - "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": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ] }, { - "description": "Updates the snapshot policy.", - "isasync": true, - "name": "updateSnapshotPolicy", + "description": "List public IP addresses in quarantine.", + "isasync": false, + "name": "listQuarantinedIps", "params": [ { - "description": "the ID of the snapshot policy", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "description": "Show IPs removed from quarantine.", "length": 255, - "name": "fordisplay", + "name": "showremoved", "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", + "description": "Show IPs that are no longer in quarantine.", "length": 255, - "name": "customid", + "name": "showinactive", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "", + "related": "updateQuarantinedIp", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" }, + {}, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "ID of the quarantine process.", + "name": "id", "type": "string" }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, {}, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -133938,32 +139320,63 @@ "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + } + ], + "since": "4.19" + }, + { + "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", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "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": "Retrieves the current status of asynchronous job.", - "isasync": false, - "name": "queryAsyncJobResult", + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", "params": [ { - "description": "the ID of the asynchronous job", + "description": "ID of the host", "length": 255, - "name": "jobid", - "related": "queryAsyncJobResult", + "name": "hostid", + "related": "reconnectHost", "required": true, "type": "uuid" } @@ -133971,201 +139384,262 @@ "related": "", "response": [ { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "operation status", + "name": "status", + "type": "boolean" }, + {}, { - "description": "the domain id that executed the async command", - "name": "domainid", - "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", + "description": "the host HA provider", + "name": "haprovider", "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "List Swift.", + "isasync": false, + "name": "listSwifts", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the id of the swift", + "length": 255, + "name": "id", + "required": false, + "type": "long" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the async command executed", - "name": "cmd", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, - {} - ] - }, - { - "description": "Adds a netscaler control center device", - "isasync": true, - "name": "registerNetscalerControlCenter", - "params": [ { - "description": "Credentials to reach netscaler controlcenter device", - "length": 255, - "name": "username", - "required": true, + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {}, { - "description": "Credentials to reach netscaler controlcenter device", - "length": 255, - "name": "numretries", - "required": true, - "type": "integer" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "Credentials to reach netscaler controlcenter device", - "length": 255, - "name": "password", - "required": true, + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Enables out-of-band management for a host", + "isasync": true, + "name": "enableOutOfBandManagementForHost", + "params": [ + { + "description": "the ID of the host", "length": 255, - "name": "ipaddress", + "name": "hostid", + "related": "reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", "type": "boolean" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "the operation result", + "name": "status", "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 out-of-band management interface port", + "name": "port", + "type": "string" }, {}, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" - }, + } + ], + "since": "4.9.0" + }, + { + "description": "Deletes a service offering.", + "isasync": false, + "name": "deleteServiceOffering", + "params": [ { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "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": "the current status of the latest async job acting on this object", @@ -134173,116 +139647,108 @@ "type": "integer" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "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": "device state", - "name": "lbdevicestate", - "type": "string" } ] }, { - "description": "Lists image stores.", + "description": "Lists supported Kubernetes version", "isasync": false, - "name": "listImageStores", + "name": "listKubernetesSupportedVersions", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Zone ID for the image store", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the image store provider", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "read-only status of the image store", + "description": "the minimum semantic version for the Kubernetes supported version to be listed", "length": 255, - "name": "readonly", - "related": "listImageStores", + "name": "minimumsemanticversion", "required": false, - "since": "4.15.0", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", - "related": "listImageStores", + "related": "listKubernetesSupportedVersions", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the name of the image store", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "name", + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the image store protocol", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "protocol", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the name of the image store", - "name": "name", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" + }, + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, { - "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 minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -134290,125 +139756,110 @@ "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "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 name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the url of the image store", - "name": "url", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the Zone ID of the image store", + "description": "the id of the zone in which Kubernetes supported version is available", "name": "zoneid", "type": "string" - } - ], - "since": "4.2.0" + }, + { + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" + }, + {} + ] }, { - "description": "Deletes a account, and all users associated with this account", + "description": "Adds a Nicira NVP device", "isasync": true, - "name": "deleteAccount", + "name": "addNiciraNvpDevice", "params": [ { - "description": "Account id", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", + "name": "hostname", "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 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 L2 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l2gatewayserviceuuid", + "required": false, "type": "string" - } - ] - }, - { - "description": "Adds metric counter for VM auto scaling", - "isasync": true, - "name": "createCounter", - "params": [ + }, { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "value", + "name": "username", "required": true, "type": "string" }, { - "description": "Source of the counter.", + "description": "the Physical Network ID", "length": 255, - "name": "source", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Network provider of the counter.", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "provider", + "name": "password", "required": true, - "since": "4.18.0", "type": "string" }, { - "description": "Name of the counter.", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "name", + "name": "transportzoneuuid", "required": true, "type": "string" } @@ -134416,8 +139867,14 @@ "related": "", "response": [ { - "description": "Source of the counter.", - "name": "source", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, + {}, + { + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { @@ -134425,539 +139882,418 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, - {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Provider of the counter.", + "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "List Event Types", - "isasync": false, - "name": "listEventTypes", - "params": [], - "related": "", - "response": [ - {}, - { - "description": "Event Type", - "name": "name", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Disables out-of-band management for a cluster", - "isasync": true, - "name": "disableOutOfBandManagementForCluster", - "params": [ - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - } - ], + "description": "Lists infrastructure", + "isasync": false, + "name": "listInfrastructure", + "params": [], "related": "", "response": [ - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "Number of internal LBs", + "name": "ilbvms", + "type": "integer" }, + {}, + {}, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "Number of clusters", + "name": "clusters", + "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "Number of storage pools", + "name": "storagepools", + "type": "integer" }, - {}, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "Number of pods", + "name": "pods", + "type": "integer" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "Number of zones", + "name": "zones", + "type": "integer" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "Number of object stores", + "name": "objectstores", + "type": "integer" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "Number of management servers", + "name": "managementservers", + "type": "integer" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "Number of cpu sockets", + "name": "cpusockets", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "Number of routers", + "name": "routers", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - } - ], - "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", - "length": 255, - "name": "managementserverid", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" - }, - {}, - { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "Number of hypervisor hosts", + "name": "hosts", + "type": "integer" } ], - "since": "4.19.0" + "since": "4.9.3" }, { - "description": "Adds a new cluster", + "description": "Lists usage records for accounts", "isasync": false, - "name": "addCluster", + "name": "listUsageRecords", "params": [ { - "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": "Flag to enable display of Tags for a resource", "length": 255, - "name": "guestvswitchtype", + "name": "includetags", "required": false, - "type": "string" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged", - "length": 255, - "name": "clustertype", - "required": true, - "type": "string" - }, - { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "type": "boolean" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "isrecursive", "required": false, - "since": "4.20", - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "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 by keyword", "length": 255, - "name": "publicvswitchtype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "List usage records for specified project", "length": 255, - "name": "vsmpassword", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "List usage records for the specified usage type", "length": 255, - "name": "vsmipaddress", + "name": "type", "required": false, - "type": "string" + "type": "long" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "", "length": 255, - "name": "allocationstate", + "name": "page", "required": false, - "type": "string" - }, - { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the username for the VSM associated with this cluster", + "description": "List usage records for the specified user.", "length": 255, - "name": "vsmusername", + "name": "account", "required": false, "type": "string" }, { - "description": "the Zone ID for the cluster", + "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": "zoneid", - "related": "listZones", + "name": "startdate", "required": true, - "type": "uuid" - }, - { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", - "length": 255, - "name": "publicvswitchname", - "required": false, - "type": "string" - }, - { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, - "type": "string" + "type": "date" }, { - "description": "the username for the cluster", + "description": "List usage records for the specified account", "length": 255, - "name": "username", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "ovm3vip", + "name": "usageid", "required": false, "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "ovm3pool", + "name": "oldformat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the cluster name", + "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": "clustername", + "name": "enddate", "required": true, - "type": "string" - }, - { - "description": "the URL", - "length": 255, - "name": "url", - "required": false, - "type": "string" + "type": "date" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "", "length": 255, - "name": "guestvswitchname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "List usage records for the specified domain.", "length": 255, - "name": "ovm3cluster", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" + "description": "resource size", + "name": "size", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the resource is default", + "name": "isdefault", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "description": "start date of the usage record", + "name": "startdate", + "type": "date" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "virtual machine ID", + "name": "virtualmachineid", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "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 percentage of capacity currently in use", - "name": "percentused", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, - {}, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "template ID", + "name": "templateid", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, + {}, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "end date of the usage record", + "name": "enddate", + "type": "date" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "resource type", + "name": "type", "type": "string" }, - {}, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "usage type ID", + "name": "usagetype", + "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" + }, + { + "description": "the project id of the resource", + "name": "projectid", "type": "string" - } - ] - }, - { - "description": "Deletes an traffic monitor host.", - "isasync": false, - "name": "deleteTrafficMonitor", - "params": [ + }, { - "description": "Id of the Traffic Monitor Host.", - "length": 255, - "name": "id", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "offering ID", + "name": "offeringid", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "usage in hours", + "name": "usage", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -134965,407 +140301,272 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the network", + "name": "networkid", + "type": "string" + }, + { + "description": "the project name of the resource", + "name": "project", "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": "Removes VM from specified network by deleting a NIC", - "isasync": true, - "name": "removeNicFromVirtualMachine", - "params": [ - { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" }, { - "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,listVnfAppliances,importVm", - "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,listVnfAppliances,importVm", - "response": [ + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the user account Id", + "name": "accountid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description of the usage record", + "name": "description", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the user account name", + "name": "account", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "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": "Recovers a Destroy volume.", + "isasync": false, + "name": "recoverVolume", + "params": [ { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + } + ], + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "ID of the disk offering", + "name": "diskofferingid", "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", + "description": "name of the disk offering", "name": "diskofferingname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the 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 netmask of the nic", - "name": "netmask", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the 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", - "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": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -135374,28 +140575,28 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -135403,6 +140604,11 @@ "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", @@ -135412,822 +140618,561 @@ "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, - {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "shared or local storage", + "name": "storagetype", "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 name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "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 read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "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": "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": "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "remove Tungsten-Fabric network gateway from logical router", + "isasync": true, + "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "params": [ + { + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "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": "ssh key-pairs", - "name": "keypairs", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" + } + ] + }, + { + "description": "Lists unmanaged volumes on a storage pool", + "isasync": false, + "name": "listVolumesForImport", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the path of the volume on the storage pool", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "name of the primary storage hosting the volume", + "name": "storage", + "type": "string" }, { - "description": "Vm details in key/value pairs.", + "description": "volume details in key/value pairs.", "name": "details", "type": "map" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the size of the volume", + "name": "size", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the full path of the volume", + "name": "fullpath", "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 path of the volume", + "name": "path", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the format of the volume", + "name": "format", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the volume", + "name": "name", "type": "string" } - ] + ], + "since": "4.19.1" }, { - "description": "Activates a project", - "isasync": true, - "name": "activateProject", + "description": "Lists zone metrics", + "isasync": false, + "name": "listZonesMetrics", "params": [ { - "description": "id of the project to be modified", + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, + "type": "string" + }, + { + "description": "the ID of the zone", "length": 255, "name": "id", - "related": "activateProject", - "required": true, + "related": "listZones", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "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 name of the zone", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -136236,13 +141181,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -136251,285 +141196,346 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the name of the project", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "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 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 allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" }, { - "description": "the total memory (in MB) owned by project", + "description": "the total cpu capacity in GiB", "name": "memorytotal", - "type": "long" + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "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 project account name of the project", - "name": "projectaccountname", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, - {}, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "healthy / total clusters in the zone", + "name": "clusters", + "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Delete a certificate to CloudStack", - "isasync": false, - "name": "deleteSslCert", - "params": [ + }, { - "description": "Id of SSL certificate", - "length": 255, - "name": "id", - "related": "uploadSslCert", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" } - ] + ], + "since": "4.9.3" }, { - "description": "Lists dedicated hosts.", - "isasync": false, - "name": "listDedicatedHosts", + "description": "Extracts a template", + "isasync": true, + "name": "extractTemplate", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the domain associated with the host", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list dedicated hosts by affinity group", + "description": "the ID of the template", "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "account", - "required": false, + "name": "mode", + "required": true, "type": "string" - }, - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addBaremetalHost,reconnectHost", - "required": false, - "type": "uuid" } ], - "related": "", + "related": "extractSnapshot", "response": [ { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "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" }, { @@ -136538,141 +141544,88 @@ "type": "integer" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "hostname", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the state of the extracted object", + "name": "state", "type": "string" - } - ] - }, - { - "description": "upload an existing ISO into the CloudStack cloud.", - "isasync": false, - "name": "getUploadParamsForIso", - "params": [ - { - "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 format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the name of the volume/template/iso", - "length": 255, + "description": "the name of the extracted object", "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": false, "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "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, + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "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": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "true if you want this ISO to be featured", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "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": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, + {}, + {}, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of extracted object", + "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", + "isasync": true, + "name": "expungeVirtualMachine", + "params": [ { - "description": "Upload volume/template/iso for the project", + "description": "The ID of the virtual machine", "length": 255, - "name": "projectid", - "related": "", - "required": false, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -136680,16 +141633,6 @@ "name": "jobid", "type": "string" }, - { - "description": "the timestamp after which the signature expires", - "name": "expires", - "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", @@ -136697,323 +141640,135 @@ }, {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.13" + ] }, { - "description": "Get diagnostics and files from system VMs", + "description": "Updates an IP address", "isasync": true, - "name": "getDiagnosticsData", + "name": "updateIpAddress", "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.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "files", + "name": "customid", "required": false, - "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "since": "4.4", "type": "string" - } - ], - "since": "4.14.0.0" - }, - { - "description": "Deletes a autoscale vm group.", - "isasync": true, - "name": "deleteAutoScaleVmGroup", - "params": [ - { - "description": "true if all VMs have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "type": "boolean" }, { - "description": "the ID of the autoscale group", + "description": "the ID of the public IP address to update", "length": 255, "name": "id", - "related": "", + "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": "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": "lists Palo Alto firewall devices in a physical network", - "isasync": false, - "name": "listPaloAltoFirewalls", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "required": false, - "type": "uuid" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "List by keyword", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], - "related": "addPaloAltoFirewall", + "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the private security zone of the external firewall", - "name": "privatezone", - "type": "string" - }, - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "device name", - "name": "fwdevicename", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" - }, - { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the physical network to which this Palo Alto firewall belongs to", + "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" - } - ] - }, - { - "description": "Updates load balancer", - "isasync": true, - "name": "updateLoadBalancerRule", - "params": [ - { - "description": "the name of the load balancer rule", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule to update", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": false, - "type": "string" }, { - "description": "The protocol for the LB", - "length": 255, - "name": "protocol", - "required": false, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, + "description": "the project name of the address", + "name": "project", "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": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, + {}, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "listLoadBalancerRules", - "response": [ - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "public IP address id", + "name": "id", "type": "string" }, - {}, - {}, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" + "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", @@ -137021,72 +141776,67 @@ "type": "integer" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "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 list of resource tags associated with load balancer", + "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -137095,973 +141845,663 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "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 zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - } - ] - }, - { - "description": "Delete one or more alerts.", - "isasync": false, - "name": "deleteAlerts", - "params": [ - { - "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, + "description": "date the public IP address was acquired", + "name": "allocated", "type": "date" }, { - "description": "delete by alert type", - "length": 255, - "name": "type", - "required": false, + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } ] }, { - "description": "Enables an account", - "isasync": false, - "name": "enableAccount", + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", "params": [ { - "description": "Enables specified account in this domain.", + "description": "the ID of the network", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, "type": "uuid" }, { - "description": "Enables specified account.", + "description": "network offering ID", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Account id", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", + "name": "resume", "required": false, - "type": "uuid" + "type": "boolean" } ], - "related": "listAccounts", + "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "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 network domain", - "name": "networkdomain", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the list of users associated with account", - "name": "user", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the user firstname", - "name": "firstname", - "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": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the user", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the project name where tag belongs to", + "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 name of the role", - "name": "rolename", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, + {}, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "the date when this account was created", + "description": "the date this network was created", "name": "created", "type": "date" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "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 VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the name of the account", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the name of the network", "name": "name", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "path of the Domain the account belongs to", + "description": "path of the Domain the network belongs to", "name": "domainpath", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "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 total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - } - ] - }, - { - "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": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": true, + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the Id of the storage pool", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "the Id of the cluster to use if scope is being set to Cluster", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.19.1" - }, - { - "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", - "isasync": true, - "name": "createAutoScaleVmProfile", - "params": [ - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "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": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is expunged", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, - "type": "integer" - }, - { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the Userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18.1", - "type": "uuid" - }, - { - "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 network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "length": 255, - "name": "autoscaleuserid", - "related": "getUser", - "required": false, - "type": "uuid" - }, - { - "description": "an optional project for the autoscale VM profile", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "account that will own the autoscale VM profile", - "length": 255, + "description": "the owner of the network", "name": "account", - "required": false, "type": "string" }, { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "domain ID of the account owning a autoscale VM profile", - "length": 255, - "name": "domainid", - "related": "listDomains", - "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" - } - ], - "related": "", - "response": [ - { - "description": "the project name of the vm profile", - "name": "project", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "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": "Name of the provider from the list of OAuth providers supported in CloudStack", - "length": 255, - "name": "provider", - "required": true, - "type": "string" - }, - { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": true, - "type": "string" - }, - { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": true, - "type": "string" - }, - { - "description": "Description of the OAuth Provider", - "length": 255, - "name": "description", - "required": true, + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true network requires restart", + "name": "restartrequired", "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" + "since": "4.11.0" }, { - "description": "Lists load balancer stickiness policies.", + "description": "Lists unmanaged virtual machines for a given cluster.", "isasync": false, - "name": "listLBStickinessPolicies", + "name": "listUnmanagedInstances", "params": [ { "description": "", @@ -138070,13 +142510,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -138085,808 +142518,988 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the hypervisor name of the instance", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "lbruleid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "the cluster ID", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", - "required": false, + "name": "clusterid", + "related": "addCluster", + "required": true, "type": "uuid" } ], "related": "", "response": [ { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "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 domain of the Stickiness policy", - "name": "domain", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "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": "is policy for display to the regular user", - "name": "fordisplay", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], - "type": "list" + "type": "set" }, + {}, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "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": "datastorehost", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "the name of the Stickiness policy", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], - "since": "3.0.0" + "since": "4.14.0" }, { - "description": "Adds a Ucs manager", + "description": "Registers an existing template into the CloudStack cloud.", "isasync": false, - "name": "addUcsManager", + "name": "registerTemplate", "params": [ { - "description": "the name of UCS manager", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "the name of the template", "length": 255, "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the Zone id for the ucs manager", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "the password of UCS", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "the name of UCS url", + "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "length": 255, + "name": "zoneids", + "related": "listZones", + "required": false, + "type": "list" + }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, "name": "url", "required": true, "type": "string" }, { - "description": "the username of UCS", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, + "name": "isrouting", + "required": false, + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the url of ucs manager", - "name": "url", - "type": "string" + "description": "Register template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "true if the template 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": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" + }, + { + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, "type": "string" }, - {}, { - "description": "the name of ucs manager", - "name": "name", + "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": "Deletes a network", - "isasync": true, - "name": "deleteNetwork", - "params": [ + }, { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "forced", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the ID of the network", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "true if the template 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", + "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": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, - {}, - {} - ] - }, - { - "description": "Reconnects a host.", - "isasync": true, - "name": "reconnectHost", - "params": [ { - "description": "the host ID", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "id", - "related": "addBaremetalHost,reconnectHost", - "required": true, - "type": "uuid" + "name": "directdownload", + "required": false, + "type": "boolean" } ], - "related": "addBaremetalHost", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum 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" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host version", - "name": "version", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the host", - "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 name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the date and time the host was removed", + "description": "the date this template 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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the Zone name of the host", - "name": "zonename", - "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, - {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the template name", + "name": "name", + "type": "string" } ] }, { - "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteVnfTemplate", + "description": "List VNF appliance owned by the account.", + "isasync": false, + "name": "listVnfAppliances", "params": [ { - "description": "Force delete a template.", + "description": "list by network id", "length": 255, - "name": "forced", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "since": "4.9+", - "type": "boolean" + "type": "uuid" }, { - "description": "Necessary if the template's type is system.", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "issystem", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "since": "4.20.0", - "type": "boolean" + "since": "4.18.0", + "type": "uuid" }, { - "description": "the ID of the template", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "the ID of zone of the template", + "description": "the security group ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "securitygroupid", + "related": "", "required": false, + "since": "4.15", "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": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Deletes a project", - "isasync": true, - "name": "deleteProject", - "params": [ { - "description": "true if all project resources have to be cleaned up, false otherwise", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "cleanup", + "name": "listall", "required": false, - "since": "4.16.0", "type": "boolean" }, { - "description": "id of the project to be deleted", + "description": "list vms by affinity group", "length": 255, - "name": "id", + "name": "affinitygroupid", "related": "", - "required": true, + "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "lists netscaler load balancer devices", - "isasync": false, - "name": "listNetscalerLoadBalancers", - "params": [ { - "description": "List by keyword", + "description": "the ID of the virtual machine", "length": 255, - "name": "keyword", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "netscaler load balancer device ID", + "description": "list vms by iso", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "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": "physicalnetworkid", - "related": "", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "page", + "name": "retrieveonlyresourcecount", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -138894,1720 +143507,2122 @@ "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "addNetscalerLoadBalancer", - "response": [ - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "device state", - "name": "lbdevicestate", - "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": "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": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "getUser", + "required": false, + "type": "uuid" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "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": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "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": "name of the provider", - "name": "provider", - "type": "string" - } - ] - }, - { - "description": "Creates a vm group", - "isasync": false, - "name": "createInstanceGroup", - "params": [ + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + }, { - "description": "the domain ID of account owning the instance group", + "description": "list by the backup offering", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "The project of the instance group", + "description": "list by the service offering", "length": 255, - "name": "projectid", - "related": "", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the name of the instance group", + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "list" } ], - "related": "", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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 instance group", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "the project name of the instance group", - "name": "project", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Lists all available shared filesystem providers.", - "isasync": false, - "name": "listSharedFileSystemProviders", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the 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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the name of the shared filesystem provider", - "name": "name", + "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", + "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" - } - ], - "since": "4.20.0" - }, - { - "description": "List iso visibility and all accounts that have permissions to view this iso.", - "isasync": false, - "name": "listIsoPermissions", - "params": [ - { - "description": "the template ID", - "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": "the template ID", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "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 projects the template is available for", - "name": "projectids", - "type": "list" + "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 to which the template belongs", - "name": "domainid", - "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": "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", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, - {}, - {} - ] - }, - { - "description": "Adds a netscaler load balancer device", - "isasync": true, - "name": "addNetscalerLoadBalancer", - "params": [ { - "description": "URL of the netscaler load balancer appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "password", - "required": true, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "private IP of the site", - "length": 255, - "name": "gslbproviderprivateip", - "required": false, - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", - "length": 255, - "name": "isexclusivegslbprovider", - "required": false, - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if NetScaler device being added is for providing GSLB service", - "length": 255, - "name": "gslbprovider", - "required": false, - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "public IP of the site", - "length": 255, - "name": "gslbproviderpublicip", - "required": false, - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "username", - "required": true, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - {}, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "User VM type", + "name": "vmtype", "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": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" - } - ] - }, - { - "description": "Creates an internal load balancer", - "isasync": true, - "name": "createLoadBalancer", - "params": [ + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "The guest network the load balancer will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the source IP address the network traffic will be load balanced from", - "length": 255, - "name": "sourceipaddress", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the network id of the source ip address", - "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", - "length": 255, - "name": "scheme", - "required": true, + "description": "the project name of the vm", + "name": "project", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "instance port of the load balancer rule", - "name": "instanceport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" - } - ], - "type": "list" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ + }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], - "type": "list" + "type": "set" }, + {}, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" - } - ], - "type": "list" - } - ], - "since": "4.2.0" - }, - { - "description": "Removes network permissions.", - "isasync": false, - "name": "removeNetworkPermissions", - "params": [ + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "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": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "the user's name who deployed the virtual machine", + "name": "username", + "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", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.17.0" - }, - { - "description": "list baremetal pxe server", - "isasync": false, - "name": "listBaremetalPxeServers", - "params": [ + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, { - "description": "Pxe server device ID", - "length": 255, - "name": "id", - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "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": "device id of ", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + { + "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", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "url", - "name": "url", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" } - ] + ], + "since": "4.19.1" }, { - "description": "Adds a Palo Alto firewall device", - "isasync": true, - "name": "addPaloAltoFirewall", + "description": "Adds stratosphere ssp server", + "isasync": false, + "name": "addStratosphereSsp", "params": [ { - "description": "Credentials to reach Palo Alto firewall device", + "description": "stratosphere ssp api name", "length": 255, - "name": "password", + "name": "name", "required": true, "type": "string" }, { - "description": "URL of the Palo Alto appliance.", + "description": "stratosphere ssp api username", "length": 255, - "name": "url", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "stratosphere ssp server url", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "stratosphere ssp api password", "length": 255, - "name": "username", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "supports only PaloAltoFirewall", + "description": "the zone ID", "length": 255, - "name": "networkdevicetype", + "name": "zoneid", + "related": "listZones", "required": true, + "type": "uuid" + }, + { + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", + "description": "zone which this ssp controls", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "server id of the stratosphere ssp server", + "name": "hostid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "name", + "name": "name", + "type": "string" }, + {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "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": "the private security zone of the external firewall", - "name": "privatezone", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, + {} + ] + }, + { + "description": "Creates a storage pool.", + "isasync": false, + "name": "createStoragePool", + "params": [ { - "description": "device state", - "name": "fwdevicestate", + "description": "the storage provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" + "description": "whether the storage should be managed by CloudStack", + "length": 255, + "name": "managed", + "required": false, + "type": "boolean" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "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 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 zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - } - ] - }, - { - "description": "Creates a private gateway", - "isasync": true, - "name": "createPrivateGateway", - "params": [ - { - "description": "the Physical Network ID the network belongs to", + "description": "the details for the storage pool", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the network implementation uri for the private gateway", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "vlan", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "scope", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "sourcenatsupported", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the IP address of the Private gateaway", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "ipaddress", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the tags for the storage pool", "length": 255, - "name": "networkofferingid", - "related": "", + "name": "tags", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the VPC network belongs to", + "description": "the name for the storage pool", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the gateway of the Private gateway", + "description": "the URL of the storage pool", "length": 255, - "name": "gateway", + "name": "url", "required": true, "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", + "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": "associatednetworkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "hypervisor", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "the ID of the network ACL", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "capacitybytes", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the netmask of the Private gateway", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "netmask", - "required": true, - "type": "string" + "name": "istagarule", + "required": false, + "type": "boolean" } ], - "related": "createPrivateGateway,listPrivateGateways", + "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, - {}, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + {}, + {}, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "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": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" } - ], - "since": "4.17.0" + ] }, { - "description": "Find user account by API key", + "description": "Lists storage pools available for migration of a volume.", "isasync": false, - "name": "getUser", + "name": "findStoragePoolsForMigration", "params": [ { - "description": "API key of the user", + "description": "List by keyword", "length": 255, - "name": "userapikey", - "required": true, + "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 volume", + "length": 255, + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the storage pool type", + "name": "type", "type": "string" }, - {}, { - "description": "the user state", - "name": "state", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the 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 storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, + {}, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - } - ] - }, - { - "description": "Lists load balancer rules.", - "isasync": false, - "name": "listLoadBalancerRules", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the Pod name of the storage pool", + "name": "podname", + "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": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "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 Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the name of the load balancer rule", - "length": 255, + "description": "the name of the storage pool", "name": "name", - "required": false, "type": "string" }, { - "description": "the ID of the virtual machine of the load balancer rule", - "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,listVnfAppliances,importVm", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the public IP address ID of the load balancer rule", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + } + ] + }, + { + "description": "delete Tungsten-Fabric firewall rule", + "isasync": true, + "name": "deleteTungstenFabricFirewallRule", + "params": [ { - "description": "the availability zone ID", + "description": "the ID of zone", "length": 255, "name": "zoneid", "related": "listZones", - "required": false, + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "keyword", - "required": false, + "name": "firewallruleuuid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "any text associated with the success or failure", + "name": "displaytext", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "list by network ID the rule belongs to", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listCiscoNexusVSMs", "response": [ { - "description": "the project name of the load balancer", - "name": "project", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, - {}, { - "description": "the description of the load balancer", - "name": "description", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "the state of the rule", - "name": "state", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + } + ] + }, + { + "description": "Creates a Storage network IP range.", + "isasync": true, + "name": "createStorageNetworkIpRange", + "params": [ + { + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "UUID of pod where the ip range belongs to", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": true, "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "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" + }, + { + "description": "the gateway for storage network", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the gateway of the storage network IP range", + "name": "gateway", "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 protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the load balancer rule ID", + "description": "the uuid of storage network IP range.", "name": "id", "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 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": "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": "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "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", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Deletes a firewall rule", + "description": "Configures an ovs element.", "isasync": true, - "name": "deleteFirewallRule", + "name": "configureOvsElement", "params": [ { - "description": "the ID of the firewall rule", + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + }, + { + "description": "the ID of the ovs provider", "length": 255, "name": "id", - "related": "", + "related": "configureOvsElement", "required": true, "type": "uuid" } ], + "related": "", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" + }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -140616,1288 +145631,1266 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, - {} + { + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" + }, + {}, + {}, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + } ] }, { - "description": "Upload a certificate to CloudStack", + "description": "Lists System VM stats", "isasync": false, - "name": "uploadSslCert", + "name": "listSystemVmsUsageHistory", "params": [ { - "description": "Enables revocation checking for certificates", + "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": "enabledrevocationcheck", + "name": "name", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "description": "domain ID of the account owning the SSL certificate", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "account that will own the SSL certificate", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "account", + "name": "ids", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "Name for the uploaded certificate", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "Password for the private key", + "description": "", "length": 255, - "name": "password", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional project for the SSL certificate", + "description": "the ID of the system VM.", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, "type": "uuid" }, { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "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": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the certificate", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", + "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": "account for the certificate", - "name": "account", - "type": "string" - }, - {}, - { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { - "description": "name", + "description": "the name of the virtual machine", "name": "name", "type": "string" - }, + } + ], + "since": "4.18.0" + }, + { + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", + "params": [ { - "description": "certificate chain", - "name": "certchain", - "type": "string" + "description": "the ID of the IPv6 firewall rule", + "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": "SSL certificate ID", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "certificate", - "name": "certificate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} ] }, { - "description": "Updates the registered OAuth provider details", - "isasync": false, - "name": "updateOauthProvider", + "description": "Creates a firewall rule for a given IP address", + "isasync": true, + "name": "createFirewallRule", "params": [ { - "description": "Description of the OAuth Provider", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "description", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "redirecturi", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "id of the OAuth provider to be updated", + "description": "type of firewallrule: system/user", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" }, { - "description": "OAuth provider will be enabled or disabled based on this value", + "description": "the starting port of firewall rule", "length": 255, - "name": "enabled", + "name": "startport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "secretkey", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "error code for this icmp message", "length": 255, - "name": "clientid", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "updateEgressFirewallRule", "response": [ { - "description": "ID of the provider", - "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { - "description": "Name of the provider", - "name": "name", + "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": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + {}, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "Name of the provider", - "name": "provider", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" } - ], - "since": "4.19.0" + ] }, { - "description": "Creates site to site vpn customer gateway", + "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": "createVpnCustomerGateway", + "name": "createVolume", "params": [ { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "ipsecpsk", - "required": true, + "name": "customid", + "required": false, "type": "string" }, { - "description": "create site-to-site VPN customer gateway for the project", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "projectid", - "related": "", + "name": "snapshotid", + "related": "listSnapshots", "required": false, - "since": "4.6", "type": "uuid" }, { - "description": "If DPD is enabled for VPN connection", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "dpd", + "name": "account", "required": false, - "type": "boolean" - }, - { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, "type": "string" }, { - "description": "name of this customer gateway", + "description": "the name of the disk volume", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, - "name": "account", + "name": "displayvolume", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "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": "ikelifetime", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "long" - }, - { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "description": "the ID of the availability zone", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "public ip address id of the customer gateway", + "description": "min iops", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "forceencap", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "the 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": "ikeversion", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.15.1", - "type": "string" + "type": "uuid" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Arbitrary volume size", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "size", + "required": false, + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "max iops", "length": 255, - "name": "splitconnections", + "name": "maxiops", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "long" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "esplifetime", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "type": "uuid" } ], - "related": "", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the domain name of the owner", + "description": "the domain associated with the disk volume", "name": "domain", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "shared or local storage", + "name": "storagetype", + "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": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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 project id", - "name": "projectid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" - } - ] - }, - { - "description": "Creates a Management network IP range.", - "isasync": true, - "name": "createManagementNetworkIpRange", - "params": [ - { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" }, { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": false, + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "The gateway for the management network.", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "The netmask for the management network.", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, + "description": "pod name of the volume", + "name": "podname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the ID of the 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 Zone name of the Pod", - "name": "zonename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - } - ], - "type": "list" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the capacity name", - "name": "name", - "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 type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - } - ], - "type": "list" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the name of the Pod", - "name": "name", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the path of the volume", + "name": "path", + "type": "string" }, - {} - ], - "since": "4.11.0.0" - }, - { - "description": "Adds vpn users", - "isasync": true, - "name": "addVpnUser", - "params": [ { - "description": "password for the username", - "length": 255, - "name": "password", - "required": true, + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "add vpn user to the specific project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the vpn userID", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, - {}, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" } ] }, { - "description": "add a baremetal host", + "description": "List virtual machine snapshot by conditions", "isasync": false, - "name": "addBaremetalHost", + "name": "listVMSnapshot", "params": [ { - "description": "the cluster ID for the host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "clusterid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "allocationstate", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "list of tags to be added to the host", + "description": "the ID of the vm", "length": 255, - "name": "hosttags", + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the host URL", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "url", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "the cluster name for the host", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "clustername", + "name": "account", "required": false, "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddress", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the Pod ID for the host", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "podid", + "name": "projectid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "password", + "name": "state", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": false, + "type": "uuid" + } + ], + "related": "createVMSnapshot", + "response": [ { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the list of resource tags associated", + "name": "tags", "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 Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" }, - {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "VM Snapshot type", + "name": "type", "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 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 Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the host hypervisor", + "description": "the type of hypervisor on which snapshot is stored", "name": "hypervisor", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "indicates if this is current snapshot", + "name": "current", "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, + } + ], + "since": "4.2.0" + }, + { + "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 last annotation set on this host by an admin", - "name": "annotation", + "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, "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "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": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "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 amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "The ID of the network ACL rule that is being moved to a new position.", + "length": 255, + "name": "id", + "required": true, "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", + "length": 255, + "name": "nextaclruleid", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -141905,150 +146898,170 @@ "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "name", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ - { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the (uu)id of the annotation", + "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "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 protocol of the ACL", + "name": "protocol", "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "Deletes a project role permission in the project", - "isasync": false, - "name": "deleteProjectRolePermission", + "description": "Disassociates an IP address from the account.", + "isasync": true, + "name": "disassociateIpAddress", "params": [ { - "description": "ID of the project role permission to be deleted", + "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "since": "4.19.0", + "type": "string" }, { - "description": "ID of the project where the project role permission is to be deleted", + "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "length": 255, - "name": "projectid", - "related": "", - "required": true, + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, "type": "uuid" } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -142059,7 +147072,6 @@ "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -142071,821 +147083,777 @@ "type": "integer" }, {} - ], - "since": "4.15.0" + ] }, { - "description": "Disables a role", + "description": "list baremetal dhcp servers", "isasync": false, - "name": "disableRole", + "name": "listBaremetalDhcp", "params": [ { - "description": "ID of the role", + "description": "Type of DHCP device", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "name": "dhcpservertype", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "DHCP server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" }, { - "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", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Deletes a role permission", - "isasync": false, - "name": "deleteRolePermission", - "params": [ { - "description": "ID of the role permission", + "description": "the Physical Network ID", "length": 255, - "name": "id", + "name": "physicalnetworkid", "related": "", "required": true, "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": "device id of ", + "name": "id", + "type": "string" + }, + {}, + { + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" + }, + {}, + { + "description": "url", + "name": "url", + "type": "string" + }, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the provider", + "name": "provider", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Updates the quarantine end date for the given public IP address.", - "isasync": false, - "name": "updateQuarantinedIp", + "description": "Puts storage pool into maintenance state", + "isasync": true, + "name": "enableStorageMaintenance", "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 date when the quarantine will no longer be active.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, - { - "description": "The ID of the public IP address in active quarantine.", + "description": "Primary storage ID", "length": 255, "name": "id", - "related": "updateQuarantinedIp", - "required": false, + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "required": true, "type": "uuid" } ], - "related": "", + "related": "cancelStorageMaintenance", "response": [ { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - }, - {}, - {}, - { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "The public IP address in quarantine.", + "description": "the IP address of the storage pool", "name": "ipaddress", "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "ID of the quarantine process.", + "description": "the ID of the storage pool", "name": "id", "type": "string" - } - ], - "since": "4.19" - }, - { - "description": "Update VM Schedule.", - "isasync": false, - "name": "updateVMSchedule", - "params": [ - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" }, { - "description": "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": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Enable VM schedule", - "length": 255, - "name": "enabled", - "required": false, + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "Name of the schedule", - "length": 255, - "name": "description", - "required": false, + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, - {}, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "Description of VM schedule", - "name": "description", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, - {}, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "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": "Action", - "name": "action", - "type": "action" - }, - { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "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": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "since": "4.20.0", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "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 date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "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 total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" - }, - { - "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": "Removes an existing secondary storage selector.", + "isasync": false, + "name": "removeSecondaryStorageSelector", + "params": [ { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "The unique identifier of the secondary storage selector to be removed.", "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the name of the image file", - "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": "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "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": "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 operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", - "length": 255, - "name": "vnfdetails", - "required": false, - "type": "map" - }, - { - "description": "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" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "lists all available apis on the server, provided by the Api Discovery plugin", + "isasync": false, + "name": "listApis", + "params": [ { - "description": "the format for the image", + "description": "API name", "length": 255, - "name": "format", + "name": "name", "required": false, "type": "string" - }, - { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", - "required": false, - "type": "map" - }, - { - "description": "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" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "related": "", "response": [ { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list params the api accepts", + "name": "params", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "parameter type", + "name": "type", "type": "string" }, + {}, { - "description": "tag value", - "name": "value", + "description": "the name of the api parameter", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "length of the parameter", + "name": "length", + "type": "int" }, { - "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 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": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" }, { - "description": "tag key name", - "name": "key", + "description": "description of the api parameter", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "comma separated related apis to get the parameter", + "name": "related", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "response field type", + "name": "type", "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if api is asynchronous", + "name": "isasync", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "description of the api", + "name": "description", "type": "string" }, + {}, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the api command", + "name": "name", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "comma separated related apis", + "name": "related", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + "description": "api response fields", + "name": "response", + "response": [ + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" + }, + { + "description": "the name of the api response field", + "name": "name", + "type": "string" + }, + { + "description": "response field type", + "name": "type", + "type": "string" + } + ], + "type": "set" + } + ], + "since": "4.1.0" + }, + { + "description": "deletes baremetal rack configuration text", + "isasync": true, + "name": "deleteBaremetalRct", + "params": [ { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, + "description": "RCT id", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, + {} + ] + }, + { + "description": "Creates snapshot for a vm.", + "isasync": true, + "name": "createVMSnapshot", + "params": [ { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "The ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "The description of the snapshot", + "length": 255, + "name": "description", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The display name of the snapshot", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "snapshot memory if true", + "length": 255, + "name": "snapshotmemory", + "required": false, + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, + {}, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account name to which the template belongs", - "name": "account", - "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the template name", + "description": "the name of the vm snapshot", "name": "name", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "VM Snapshot type", + "name": "type", + "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 vm snapshot", + "name": "description", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the date this template was created", + "description": "the create date of the vm snapshot", "name": "created", "type": "date" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "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 Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes an internal load balancer", + "isasync": true, + "name": "deleteLoadBalancer", + "params": [ { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, + "description": "the ID of the Load Balancer", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "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 project name of the template", - "name": "project", + "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" }, + {}, { - "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 operation is executed successfully", + "name": "success", + "type": "boolean" + } ], - "since": "4.19.0" + "since": "4.2.0" }, { - "description": "Lists all configuration groups (primarily used for UI).", + "description": "Lists Tungsten-Fabric tags", "isasync": false, - "name": "listConfigurationGroups", + "name": "listTungstenFabricTagType", "params": [ { - "description": "lists configuration group by group name", + "description": "", "length": 255, - "name": "group", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -142900,369 +147868,253 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the description of the configuration group", - "name": "description", - "type": "string" - }, - { - "description": "the precedence of the configuration group", - "name": "precedence", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, - { - "description": "the name of the configuration group", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ], - "since": "4.18.0" - }, - { - "description": "Releases a Pod IP back to the Pod", - "isasync": false, - "name": "releasePodIpAddress", - "params": [ - { - "description": "UUID of the Pod IP", - "length": 255, - "name": "id", - "required": true, - "type": "long" - } - ], - "response": [ { "description": "the 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": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" - }, - {} + } ] }, { - "description": "Updates VPC offering", + "description": "Returns a download URL for extracting a snapshot. It must be in the Backed Up state.", "isasync": true, - "name": "updateVPCOffering", + "name": "extractSnapshot", "params": [ { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the ID of the zone where the snapshot is located", "length": 255, - "name": "state", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "since": "4.20.0", + "type": "uuid" }, { - "description": "the id of the VPC offering", + "description": "the ID of the snapshot", "length": 255, "name": "id", - "related": "updateVPCOffering", + "related": "listSnapshots", "required": true, + "since": "4.20.0", "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the VPC offering", - "length": 255, + "description": "the name of the extracted object", "name": "name", - "required": false, "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "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": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "sort key of the VPC offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "the display text of the VPC offering", - "length": 255, - "name": "displaytext", - "required": false, + "description": "", + "name": "resultstring", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the upload id of extracted object", + "name": "extractId", "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 state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "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 network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "type of the storage", + "name": "storagetype", "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 status of the extraction", + "name": "status", "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability 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 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" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "List registered keypairs", + "isasync": false, + "name": "listSSHKeyPairs", + "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 routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - } - ] - }, - { - "description": "Updates remote access vpn", - "isasync": true, - "name": "updateRemoteAccessVpn", - "params": [ - { - "description": "id of the remote access vpn", + "description": "the ID of the ssh keypair", "length": 255, "name": "id", - "related": "updateRemoteAccessVpn", - "required": true, + "related": "listSSHKeyPairs", + "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "A key pair name to look for", "length": 255, - "name": "customid", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", "required": false, - "since": "4.4", "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { @@ -143271,500 +148123,374 @@ "type": "integer" }, { - "description": "the account of the remote access vpn", + "description": "the owner of the keypair", "name": "account", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" - }, {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the domain id of the keypair owner", + "name": "domainid", "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" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, + {}, { - "description": "the domain name of the account of the remote access vpn", + "description": "the domain name of the keypair owner", "name": "domain", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", + "description": "Cancels maintenance for primary storage", + "isasync": true, + "name": "cancelStorageMaintenance", "params": [ { - "description": "List user two factor authenticator provider by name", + "description": "the primary storage ID", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "cancelStorageMaintenance", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the user two factor authenticator provider name", - "name": "name", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "the Pod ID of the storage pool", + "name": "podid", "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": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "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, + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, + {}, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, + {}, { - "description": "The ID of the virtual machine", - "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,listVnfAppliances,importVm", - "required": true, - "type": "uuid" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "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", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", - "params": [ - { - "description": "If true is passed, the vm is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.2.1", - "type": "boolean" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "Comma separated list of UUIDs for volumes that will be deleted", - "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.12.0", - "type": "list" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "The ID of the virtual machine", - "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,listVnfAppliances,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,listVnfAppliances,importVm", - "response": [ + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "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": "the project id of the vm", - "name": "projectid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" + } + ] + }, + { + "description": "Updates the snapshot policy.", + "isasync": true, + "name": "updateSnapshotPolicy", + "params": [ + { + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "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" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "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 type of the nic", - "name": "type", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "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": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "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 UUID of the latest async job acting on this object", @@ -143772,737 +148498,303 @@ "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, + } + ] + }, + { + "description": "Lists balance and quota usage for all accounts", + "isasync": false, + "name": "quotaSummary", + "params": [ { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Optional, to list all accounts irrespective of the quota activity", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Optional, Account Id for which statement needs to be generated", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the 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": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "if the account has the quota config enabled", + "name": "quotaenabled", "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "end date", + "name": "enddate", + "type": "date" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" }, { - "description": "the 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": "account id", + "name": "accountid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "start date", + "name": "startdate", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "currency", + "name": "currency", "type": "string" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "account state", + "name": "state", + "type": "state" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "account balance", + "name": "balance", + "type": "bigdecimal" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "domain id", + "name": "domainid", "type": "string" - }, + } + ], + "since": "4.7.0" + }, + { + "description": "Retrieves the current status of asynchronous job.", + "isasync": false, + "name": "queryAsyncJobResult", + "params": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name 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": "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" - } - ], - "type": "set" - }, + "description": "the ID of the asynchronous job", + "length": 255, + "name": "jobid", + "related": "queryAsyncJobResult", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", "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 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 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "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" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "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": "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": "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 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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "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": "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the async command executed", + "name": "cmd", + "type": "string" }, + {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the 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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" - }, + } + ] + }, + { + "description": "Adds a netscaler control center device", + "isasync": true, + "name": "registerNetscalerControlCenter", + "params": [ { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "username", + "required": true, + "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": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "numretries", + "required": true, + "type": "integer" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "URL of the netscaler controlcenter appliance.", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Credentials to reach netscaler controlcenter device", + "length": 255, + "name": "password", + "required": true, "type": "string" - }, + } + ], + "related": "addNetscalerLoadBalancer", + "response": [ { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "device name", + "name": "lbdevicename", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "device state", + "name": "lbdevicestate", "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": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "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" }, { @@ -144510,1054 +148802,1401 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "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 state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" } ] }, { - "description": "Updates egress firewall rule ", + "description": "Adds metric counter for VM auto scaling", "isasync": true, - "name": "updateEgressFirewallRule", + "name": "createCounter", "params": [ { - "description": "the ID of the egress firewall rule", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "id", - "related": "", + "name": "value", "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", + "description": "Name of the counter.", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "name", + "required": true, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Network provider of the counter.", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "provider", + "required": true, + "since": "4.18.0", + "type": "string" + }, + { + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "Provider of the counter.", + "name": "provider", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "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" - } - ], - "type": "list" - }, {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "Source of the counter.", + "name": "source", "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" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the id of the Counter", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "List Event Types", + "isasync": false, + "name": "listEventTypes", + "params": [], + "related": "", + "response": [ { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "Event Type", + "name": "name", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - } - ], - "since": "4.4" + {} + ] }, { - "description": "Lists all supported OS categories for this cloud.", + "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", "isasync": false, - "name": "listOsCategories", + "name": "prepareForShutdown", "params": [ { - "description": "list Os category by id", + "description": "the uuid of the management server", "length": 255, - "name": "id", - "related": "listOsCategories", - "required": false, + "name": "managementserverid", + "related": "", + "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list os category by name", - "length": 255, - "name": "name", - "required": false, - "since": "3.0.1", - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the OS category", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the OS category", - "name": "name", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, - {} - ] + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" + } + ], + "since": "4.19.0" }, { - "description": "Lists all available service offerings.", + "description": "Adds a new cluster", "isasync": false, - "name": "listServiceOfferings", + "name": "addCluster", "params": [ { - "description": "", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "page", + "name": "publicvswitchname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "vsmusername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CPU number that listed offerings must support", + "description": "the Pod ID for the host", "length": 255, - "name": "cpunumber", - "required": false, - "since": "4.15", - "type": "integer" + "name": "podid", + "related": "createManagementNetworkIpRange", + "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 cluster name", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "clustername", + "required": true, + "type": "string" }, { - "description": "The ID of the template that listed offerings must support", + "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": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "name": "guestvswitchtype", "required": false, - "since": "4.20.0", - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the URL", "length": 255, - "name": "account", + "name": "url", "required": false, "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "the Zone ID for the cluster", "length": 255, "name": "zoneid", "related": "listZones", - "required": false, - "since": "4.13", + "required": true, "type": "uuid" }, { - "description": "name of the service offering", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "name", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "List by keyword", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "keyword", + "name": "ovm3cluster", "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": "ID of the service offering", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the RAM memory that listed offering must support", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "memory", + "name": "guestvswitchname", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "the CPU speed that listed offerings must support", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "cpuspeed", + "name": "ovm3vip", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "the username for the cluster", "length": 255, - "name": "storagetype", + "name": "username", "required": false, - "since": "4.19", "type": "string" }, { - "description": "listed offerings support root disk encryption", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "encryptroot", + "name": "vsmipaddress", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "pagesize", + "name": "ovm3pool", "required": false, - "type": "integer" + "type": "string" }, { - "description": "is this a system vm offering", + "description": "the password for the host", "length": 255, - "name": "issystem", + "name": "password", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "state", + "name": "vsmpassword", "required": false, - "since": "4.19", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "", + "name": "publicvswitchtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "Allocation state of this cluster for allocation of new resources", "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,listVnfAppliances,importVm", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "systemvmtype", + "name": "arch", "required": false, + "since": "4.20", "type": "string" } ], - "related": "updateServiceOffering", + "related": "", "response": [ { - "description": "state of the service offering", - "name": "state", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "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 cluster ID", + "name": "id", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, - {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the Zone name of the cluster", + "name": "zonename", "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": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "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 allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, - { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" }, + {}, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "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 name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the cluster name", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an traffic monitor host.", + "isasync": false, + "name": "deleteTrafficMonitor", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "Id of the Traffic Monitor Host.", + "length": 255, + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the id of the service offering", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Removes VM from specified network by deleting a NIC", + "isasync": true, + "name": "removeNicFromVirtualMachine", + "params": [ { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "response": [ { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag 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", + "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" + } + ], + "type": "set" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "Vm details in key/value pairs.", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" - } - ] - }, - { - "description": "Import virtual machine from a unmanaged host into CloudStack", - "isasync": true, - "name": "importVm", - "params": [ - { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, - "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 list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "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": "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 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": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" }, { - "description": "(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": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 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 ID of the nic", + "name": "id", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "required": false, - "type": "uuid" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Host where local disk is located", - "length": 255, - "name": "hostid", - "related": "", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", - "length": 255, - "name": "clustername", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "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": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "hypervisor type of the host", - "length": 255, + "description": "the hypervisor on which the template runs", "name": "hypervisor", - "required": true, "type": "string" }, { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" - }, - { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "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": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", - "length": 255, - "name": "forcemstoimportvmfiles", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "import instance for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "VM nic to network id mapping using keys nic and network", - "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" - }, - { - "description": "Temp Path on external host for disk image copy", - "length": 255, - "name": "temppath", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "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": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", - "length": 255, - "name": "hostip", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Shared storage pool where disk is located", - "length": 255, - "name": "storageid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the host name of the instance", - "length": 255, - "name": "hostname", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "path of the disk image", - "length": 255, - "name": "diskpath", - "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": "the username for the host", - "length": 255, - "name": "username", - "required": false, + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Source location for Import", - "length": 255, - "name": "importsource", - "required": true, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" - }, - { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "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,listVnfAppliances", - "response": [ - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { @@ -145566,162 +150205,244 @@ "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the affinity group", + "name": "name", "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": "the project id the tag belongs to", + "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 ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the 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": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, { "description": "the 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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { "description": "the incoming network traffic on the VM in KiB", "name": "networkkbsread", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { "description": "the name of the host for the virtual machine", @@ -145729,206 +150450,29 @@ "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the 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 account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "OS name of the vm", @@ -145936,780 +150480,404 @@ "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "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 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": "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - } - ], - "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 name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - } - ], - "type": "set" - }, - { - "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": "Lists dedicated hosts.", + "isasync": false, + "name": "listDedicatedHosts", + "params": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the ID of the domain associated with the host", + "length": 255, "name": "domainid", - "type": "string" + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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", + "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "list dedicated hosts by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": false, + "type": "uuid" }, { - "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": "", + "response": [ { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the virtual machine", + "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the host", + "name": "hostname", "type": "string" - }, + } + ] + }, + { + "description": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", + "params": [ { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "length": 255, + "name": "targetid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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 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 type of the affinity group", - "name": "type", - "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": "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" + } + ], + "since": "4.14.0.0" + }, + { + "description": "upload an existing ISO into the CloudStack cloud.", + "isasync": false, + "name": "getUploadParamsForIso", + "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": "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 name of userdata used for the VM", - "name": "userdataname", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the name of the disk 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 format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "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 OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Upload volume/template/iso for the project", + "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": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, + {}, + {}, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" } ], - "since": "4.19.0" + "since": "4.13" }, { - "description": "Removes a load balancer rule association with global load balancer rule", + "description": "Deletes a autoscale vm group.", "isasync": true, - "name": "removeFromGlobalLoadBalancerRule", + "name": "deleteAutoScaleVmGroup", "params": [ { - "description": "The ID of the load balancer rule", + "description": "true if all VMs have to be cleaned up, false otherwise", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "cleanup", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "the ID of the autoscale group", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on 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": "Lists affinity group types available", + "description": "lists Palo Alto firewall devices in a physical network", "isasync": false, - "name": "listAffinityGroupTypes", + "name": "listPaloAltoFirewalls", "params": [ { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "listPaloAltoFirewalls", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -146720,638 +150888,453 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the type of the affinity group", - "name": "type", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, - {} - ] - }, - { - "description": "Lists all the system wide capacities.", - "isasync": false, - "name": "listCapacity", - "params": [ { - "description": "Sort the results. Available values: Usage", - "length": 255, - "name": "sortby", - "required": false, - "since": "3.0.0", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, + {}, { - "description": "lists capacity by the Pod ID", - "length": 255, - "name": "podid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "lists capacity by the Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", + "description": "name of the provider", + "name": "provider", "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, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "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": "recalculate capacities and fetch the latest", - "length": 255, - "name": "fetchlatest", - "required": false, - "since": "3.0.0", - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { - "description": "the Pod name", - "name": "podname", + "description": "the zone ID of the external firewall", + "name": "zoneid", "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", + "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": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, - {}, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "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 Pod ID", - "name": "podid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, - {}, { - "description": "the capacity name", - "name": "name", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" } ] }, { - "description": "Starts a virtual machine.", + "description": "Updates load balancer", "isasync": true, - "name": "startVirtualMachine", + "name": "updateLoadBalancerRule", "params": [ { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "hostid", - "related": "", + "name": "algorithm", "required": false, - "since": "3.0.1", - "type": "uuid" + "type": "string" }, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", - "length": 255, - "name": "considerlasthost", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.18.0", - "type": "boolean" + "type": "string" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "The protocol for the LB", "length": 255, - "name": "deploymentplanner", + "name": "protocol", "required": false, - "since": "4.4", "type": "string" }, { - "description": "Boot into hardware setup menu 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": "bootintosetup", + "name": "customid", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "clusterid", + "name": "id", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "an optional field, whether to the display the rule to the end user or not", "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,listVnfAppliances", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "the name of the load balancer rule", "length": 255, - "name": "podid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "related": "listLoadBalancerRules", "response": [ + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "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 zone the rule belongs to", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the public ip address", "name": "publicip", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "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 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": "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 netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "set" - }, + "type": "list" + } + ] + }, + { + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", + "params": [ { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Account id", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "listAccounts", + "response": [ + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "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": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { "description": "the total number of network traffic bytes sent", @@ -147359,2397 +151342,3647 @@ "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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 account name of the user", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", "type": "string" } ], - "type": "set" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "type": "list" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the 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 networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the role", + "name": "rolename", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" - }, + } + ] + }, + { + "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": true, "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the Id of the cluster to use if scope is being set to Cluster", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the virtual machine", + "description": "the Id of the storage pool", + "length": 255, "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "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 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 name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.19.1" + }, + { + "description": "Deletes a network", + "isasync": true, + "name": "deleteNetwork", + "params": [ + { + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "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": "User VM type", - "name": "vmtype", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "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": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "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" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "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": "Updates a service offering.", - "isasync": false, - "name": "updateServiceOffering", + "description": "Reconnects a host.", + "isasync": true, + "name": "reconnectHost", "params": [ { - "description": "the name of the service offering to be updated", + "description": "the host ID", "length": 255, - "name": "name", - "required": false, + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", "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": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "state of the service offering", - "length": 255, - "name": "state", - "required": false, + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "length": 255, - "name": "purgeresources", - "required": false, - "since": "4.20", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the display text of the service offering to be updated", - "length": 255, - "name": "displaytext", - "required": false, + "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 containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the admin that annotated this host", + "name": "username", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the ID of the host", + "name": "id", "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "state of the service offering", - "name": "state", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "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": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" - }, - { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - {}, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" } ] }, { - "description": "Stops a virtual machine.", + "description": "Starts a stopped CloudManaged Kubernetes cluster", "isasync": true, - "name": "stopVirtualMachine", + "name": "startKubernetesCluster", "params": [ { - "description": "The ID of the virtual machine", + "description": "the ID of the Kubernetes cluster", "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", + "related": "startKubernetesCluster", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", + "related": "", "response": [ { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "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" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + } + ] + }, + { + "description": "Deletes a project", + "isasync": true, + "name": "deleteProject", + "params": [ + { + "description": "true if all project resources have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, + { + "description": "id of the project to be deleted", + "length": 255, + "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": "true if operation 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 domain in which the virtual machine exists", - "name": "domain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists all available shared filesystem providers.", + "isasync": false, + "name": "listSharedFileSystemProviders", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the name of the shared filesystem provider", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "List iso visibility and all accounts that have permissions to view this iso.", + "isasync": false, + "name": "listIsoPermissions", + "params": [ + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listTemplatePermissions,listIsoPermissions", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, + {}, + {}, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + } + ] + }, + { + "description": "Adds a netscaler load balancer device", + "isasync": true, + "name": "addNetscalerLoadBalancer", + "params": [ + { + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", + "required": true, + "type": "string" + }, + { + "description": "public IP of the site", + "length": 255, + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, + { + "description": "URL of the netscaler load balancer appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "private IP of the site", + "length": 255, + "name": "gslbproviderprivateip", + "required": false, + "type": "string" + }, + { + "description": "true if NetScaler device being added is for providing GSLB service", + "length": 255, + "name": "gslbprovider", + "required": false, + "type": "boolean" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "length": 255, + "name": "isexclusivegslbprovider", + "required": false, + "type": "boolean" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + { + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, + { + "description": "device state", + "name": "lbdevicestate", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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": "Removes network permissions.", + "isasync": false, + "name": "removeNetworkPermissions", + "params": [ + { + "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" + }, + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "", + "required": false, + "type": "list" + }, + { + "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" + } + ], + "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" + }, + {} + ], + "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 ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ] + }, + { + "description": "list baremetal pxe server", + "isasync": false, + "name": "listBaremetalPxeServers", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Pxe server device ID", + "length": 255, + "name": "id", + "required": false, "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "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", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" + }, + {} + ] + }, + { + "description": "Find user account by API key", + "isasync": false, + "name": "getUser", + "params": [ + { + "description": "API key of the user", + "length": 255, + "name": "userapikey", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the 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 domain name of the user", + "name": "domain", + "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": "the name of the role", + "name": "rolename", + "type": "string" + } + ] + }, + { + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listLoadBalancerRules", + "params": [ + { + "description": "the public IP address ID of the load balancer rule", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list by network ID the rule belongs to", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the virtual machine of the load balancer rule", + "length": 255, + "name": "virtualmachineid", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "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", + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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 list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "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 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 algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "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 guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + } + ] + }, + { + "description": "Creates a Management network IP range.", + "isasync": true, + "name": "createManagementNetworkIpRange", + "params": [ + { + "description": "The netmask for the management network.", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "The ending IP address.", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + }, + { + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" + }, + { + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "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": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of the nic", + "description": "the gateway for the range", "name": "gateway", "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the starting IP for the range", + "name": "startip", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + {}, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the description of the security group", - "name": "description", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "The tag for the capacity type", + "name": "tag", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the Pod name", + "name": "podname", "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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": "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": "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 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": "resource type", - "name": "resourcetype", - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - } - ], - "type": "set" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" } ], - "type": "set" + "type": "list" + } + ], + "since": "4.11.0.0" + }, + { + "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", + "isasync": false, + "name": "listCiscoNexusVSMs", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, + { + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", + "type": "string" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" + }, + { + "description": "device state", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "path of the domain in which the virtual machine exists", + "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": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + } + ] + }, + { + "description": "Adds vpn users", + "isasync": true, + "name": "addVpnUser", + "params": [ + { + "description": "add vpn user to the specific project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "password for the username", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", + "type": "string" + }, + { + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + { + "description": "the vpn userID", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" + }, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the remote access vpn belongs", "name": "domainpath", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the username of the vpn user", + "name": "username", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + {} + ] + }, + { + "description": "Deletes a project role permission in the project", + "isasync": false, + "name": "deleteProjectRolePermission", + "params": [ + { + "description": "ID of the project where the project role permission is to be deleted", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the project role permission to be deleted", + "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "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": "The ID of the public IP address in active quarantine.", + "length": 255, + "name": "id", + "related": "updateQuarantinedIp", + "required": false, + "type": "uuid" + }, + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "The date when the quarantine will no longer be active.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + } + ], + "related": "", + "response": [ + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" + }, + {}, + { + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19" + }, + { + "description": "Updates a template to VNF template or attributes of a VNF template.", + "isasync": false, + "name": "updateVnfTemplate", + "params": [ + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "length": 255, + "name": "vnfnics", + "required": false, + "type": "map" + }, + { + "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 ID of the image file", + "length": 255, + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "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 format for the image", + "length": 255, + "name": "format", + "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).", + "length": 255, + "name": "templatetype", + "required": false, + "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": "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 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 display text of the image", + "length": 4096, + "name": "displaytext", + "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": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "length": 255, + "name": "cleanupvnfdetails", + "required": false, + "type": "boolean" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "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", + "length": 255, + "name": "vnfdetails", + "required": false, + "type": "map" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "true if the password rest 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 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 group ID of the virtual machine", - "name": "groupid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the 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 OS type for this template.", + "name": "ostypename", "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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 owning the affinity group", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } - ] + ], + "since": "4.19.0" }, { - "description": "Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.", + "description": "Updates VPC offering", "isasync": true, - "name": "createNetworkACLList", + "name": "updateVPCOffering", "params": [ { - "description": "Name of the network ACL list", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "name", - "required": true, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the display text of the VPC offering", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "the name of the VPC offering", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "ID of the VPC associated with this network ACL list", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "state", "required": false, + "type": "string" + }, + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, "type": "uuid" }, { - "description": "Description of the network ACL list", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" + }, + { + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "description", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" } ], "related": "", "response": [ { - "description": "the Name of the ACL", - "name": "name", + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, {}, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "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" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, + {}, + { + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Description of the ACL", - "name": "description", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" } ] }, { - "description": "Add a supported Kubernetes version", + "description": "Lists user two factor authenticator providers", "isasync": false, - "name": "addKubernetesSupportedVersion", + "name": "listUserTwoFactorAuthenticatorProviders", "params": [ { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "List user two factor authenticator provider by name", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", - "length": 255, - "name": "mincpunumber", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", - "length": 255, - "name": "semanticversion", - "required": true, + "description": "the user two factor authenticator provider name", + "name": "name", "type": "string" }, { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "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": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "checksum", + "name": "automigrate", "required": false, - "type": "string" + "since": "4.17", + "type": "boolean" }, { - "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": "Verify OK to Shrink", "length": 255, - "name": "directdownload", + "name": "shrinkok", "required": false, - "since": "4.18.2", + "since": "4.17", "type": "boolean" }, { - "description": "the name of the Kubernetes supported version", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "minmemory", + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "description": "The ID of the virtual machine", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "miniops", "required": false, - "type": "uuid" + "since": "4.17", + "type": "long" } ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ + {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "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": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + {}, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the enabled or disabled state of the Kubernetes supported version", + "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "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 starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -149757,2163 +154990,2954 @@ "type": "string" }, { - "description": "the id of the Kubernetes supported version", + "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 id", + "length": 255, + "name": "id", + "related": "listOsCategories", + "required": false, + "type": "uuid" }, - {}, { - "description": "Name of the Kubernetes supported version", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list os category by name", + "length": 255, "name": "name", + "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" } + ], + "related": "", + "response": [ + { + "description": "the name of the OS category", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the OS category", + "name": "id", + "type": "string" + }, + {}, + {} ] }, { - "description": "Creates a Kubernetes cluster", - "isasync": true, - "name": "createKubernetesCluster", + "description": "Lists all available service offerings.", + "isasync": false, + "name": "listServiceOfferings", "params": [ { - "description": "name for the Kubernetes cluster", + "description": "name of the service offering", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources 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": "description", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "root disk size in GB for each node", + "description": "listed offerings support root disk encryption", "length": 255, - "name": "noderootdisksize", + "name": "encryptroot", "required": false, - "type": "long" + "since": "4.18", + "type": "boolean" }, { - "description": "Deploy cluster for the project", + "description": "ID of the service offering", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "user name for the docker image private registry", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "dockerregistryusername", + "name": "cpunumber", "required": false, - "type": "string" + "since": "4.15", + "type": "integer" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "The ID of the template that listed offerings must support", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "since": "4.20.0", + "type": "uuid" + }, + { + "description": "id of zone disk offering is associated with", "length": 255, "name": "zoneid", "related": "listZones", - "required": true, + "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "is this a system vm offering", "length": 255, - "name": "keypair", + "name": "issystem", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "length": 255, + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "controlnodes", + "name": "state", "required": false, - "type": "long" + "since": "4.19", + "type": "string" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "cpuspeed", + "required": false, + "since": "4.15", + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "clustertype", + "name": "storagetype", "required": false, - "since": "4.19.0", + "since": "4.19", + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the 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": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "", + "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": "the RAM memory that listed offering must support", + "length": 255, + "name": "memory", + "required": false, + "since": "4.15", + "type": "integer" + } + ], + "related": "updateServiceOffering", + "response": [ + { + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the name of the service offering", + "name": "name", "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": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "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": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "number of Kubernetes cluster worker nodes", - "length": 255, - "name": "size", - "required": false, + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "Kubernetes version with which cluster to be launched", - "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": false, - "type": "uuid" + "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": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", - "length": 255, - "name": "masternodes", - "required": false, + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "URL for the docker image private registry", - "length": 255, - "name": "dockerregistryurl", - "required": false, + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "password for the docker image private registry", - "length": 255, - "name": "dockerregistrypassword", - "required": false, + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, - {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, + {}, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the 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": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "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": "the state of the Kubernetes cluster", - "name": "state", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "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": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "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 of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" } ] }, { - "description": "Deletes a Kubernetes cluster", + "description": "Import virtual machine from a unmanaged host into CloudStack", "isasync": true, - "name": "deleteKubernetesCluster", + "name": "importVm", "params": [ { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "description": "hypervisor type of the host", "length": 255, - "name": "cleanup", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "path of the disk image", + "length": 255, + "name": "diskpath", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "description": "the username for the host", "length": 255, - "name": "expunge", + "name": "username", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the zone ID", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "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", - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Shared storage pool where disk is located", + "length": 255, + "name": "storageid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesSupportedVersion", - "params": [ + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" + }, { - "description": "the ID of the Kubernetes supported version", + "description": "import instance for the project", "length": 255, - "name": "id", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, + "name": "projectid", + "related": "", + "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": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "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", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster", + "name": "nicipaddresslist", "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "type": "map" + }, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "Source location for Import", + "length": 255, + "name": "importsource", + "required": true, "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "the id of the container cluster", - "name": "id", - "type": "string" + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "Name of the container cluster", - "name": "name", + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "Lists Kubernetes clusters", - "isasync": false, - "name": "listKubernetesClusters", - "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Host where local disk is located", "length": 255, - "name": "listall", + "name": "hostid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "name", + "name": "migrateallowed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "state of the Kubernetes cluster", + "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": "state", + "name": "vcenter", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "account", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the host name or IP address", "length": 255, - "name": "keyword", + "name": "host", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "convertinstancehostid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "page", + "name": "temppath", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", "length": 255, - "name": "pagesize", + "name": "hostip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "used to specify the custom parameters.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "the display name of the instance", "length": 255, - "name": "clustertype", + "name": "displayname", "required": false, - "since": "4.19.0", "type": "string" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "response": [ + }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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 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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", + "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - {}, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, + {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + {}, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ] - }, - { - "description": "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": "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" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", - "length": 255, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the virtual machine", "name": "id", - "related": "listKubernetesSupportedVersions", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the minimum semantic version for the Kubernetes supported version to be listed", - "length": 255, - "name": "minimumsemanticversion", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the minimum Kubernetes supported version", - "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "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 binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, - {}, - { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" - }, - { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" - }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "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", + "description": "User VM type", + "name": "vmtype", "type": "string" - } - ] - }, - { - "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "scaleKubernetesCluster", - "params": [ - { - "description": "the IDs of the nodes to be removed", - "length": 255, - "name": "nodeids", - "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", - "required": false, - "type": "list" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "length": 255, - "name": "autoscalingenabled", - "required": false, - "type": "boolean" - }, - { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - }, - { - "description": "Minimum number of worker nodes in the cluster", - "length": 255, - "name": "minsize", - "required": false, - "type": "long" }, { - "description": "number of Kubernetes cluster nodes", - "length": 255, - "name": "size", - "required": false, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "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" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster", - "response": [ - { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the Kubernetes cluster", - "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": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "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 account associated with the Kubernetes cluster", - "name": "account", - "type": "string" - }, - { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "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 virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "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": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "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 high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, + {}, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, - {}, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ] + ], + "since": "4.19.0" }, { - "description": "Starts a stopped CloudManaged Kubernetes cluster", + "description": "Removes a load balancer rule association with global load balancer rule", "isasync": true, - "name": "startKubernetesCluster", + "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "The ID of the load balancer rule", "length": 255, "name": "id", - "related": "startKubernetesCluster", + "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" } ], - "related": "", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" - }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, - { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" - }, - { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" - }, - { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, { "description": "the 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": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Lists affinity group types available", + "isasync": false, + "name": "listAffinityGroupTypes", + "params": [ { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists all the system wide capacities.", + "isasync": false, + "name": "listCapacity", + "params": [ { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "lists capacity by the Cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "since": "3.0.0", + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "recalculate capacities and fetch the latest", + "length": 255, + "name": "fetchlatest", + "required": false, + "since": "3.0.0", "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Sort the results. Available values: Usage", + "length": 255, + "name": "sortby", + "required": false, + "since": "3.0.0", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "lists capacity by the Pod ID", + "length": 255, + "name": "podid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "lists capacity by the Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "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, + "type": "integer" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - } - ] - }, - { - "description": "Starts a stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "startKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", + "description": "", "length": 255, - "name": "id", - "related": "startKubernetesCluster", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, + {}, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, - {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the Cluster name", + "name": "clustername", "type": "string" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, + } + ] + }, + { + "description": "Updates a service offering.", + "isasync": false, + "name": "updateServiceOffering", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering to be updated", + "length": 255, + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "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": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "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 description of the Kubernetes cluster", - "name": "description", + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "state of the service offering", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the service offering to be updated", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "since": "4.16", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "length": 255, + "name": "purgeresources", + "required": false, + "since": "4.20", + "type": "boolean" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "sort key of the service offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "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 name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "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": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the state of the Kubernetes cluster", + "description": "state of the service offering", "name": "state", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - } - ] - }, - { - "description": "Update a supported Kubernetes version", - "isasync": false, - "name": "updateKubernetesSupportedVersion", - "params": [ + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, { - "description": "the ID of the Kubernetes supported version", - "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" + "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 enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, - "type": "string" - } - ], - "related": "listKubernetesSupportedVersions", - "response": [ + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the id of the Kubernetes supported version", + "description": "the id of the service offering", "name": "id", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "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", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "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": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" - } - ] - }, - { - "description": "Upgrades a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "upgradeKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" }, { - "description": "the ID of the Kubernetes version for upgrade", - "length": 255, - "name": "kubernetesversionid", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "response": [ - { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the 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 size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - {}, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" - }, + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" + } + ], + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" - } - ] - }, - { - "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "addVirtualMachinesToKubernetesCluster", - "params": [ - { - "description": "the IDs of the VMs to add to the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "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": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "Is control node or not? Defaults to false.", - "length": 255, - "name": "iscontrolnode", - "required": false, - "type": "boolean" - } - ], - "response": [ - { - "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 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 vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "removeVirtualMachinesFromKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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, + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" - } - ], - "related": "", - "response": [ + }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the 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": "any text associated with the success or failure", - "name": "displaytext", + "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 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 operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists the VMs in a VMware Datacenter", - "isasync": false, - "name": "listVmwareDcVms", - "params": [ + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { - "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, + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "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": "The password for specified username.", - "length": 255, + "description": "the password (if exists) of the virtual machine", "name": "password", - "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" - } - ], - "related": "listUnmanagedInstances", - "response": [ + }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "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 host to which virtual machine belongs", - "name": "hostid", - "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": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "the name of the virtual machine", @@ -151921,725 +157945,746 @@ "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "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 operating system of the virtual machine", - "name": "osdisplayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the 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", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project id of the group", + "name": "projectid", "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "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 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "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", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Remove a VMware datacenter from a zone.", - "isasync": false, - "name": "removeVmwareDc", - "params": [ - { - "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": "any text associated 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", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, - {} - ] - }, - { - "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, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "VMware datacenter name.", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "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", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "The VMware Datacenter name", - "name": "name", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, {}, - { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" - }, - { - "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": "Creates a system virtual-machine that implements network services", - "isasync": true, - "name": "createServiceInstance", - "params": [ + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "An optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "Availability zone for the service instance", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, "type": "string" }, { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The left (inside) network for service instance", - "length": 255, - "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "The service offering ID that defines the resources consumed by the service appliance", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "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 project name of the vm", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, + {}, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "path of the Domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {} - ] - }, - { - "description": "Adds a VMware datacenter to specified zone", - "isasync": false, - "name": "addVmwareDc", - "params": [ { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": true, - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "The Zone ID.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Name of VMware datacenter to be added to specified zone.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "The VMware Datacenter name", - "name": "name", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "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 account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" } ] }, { - "description": "Retrieves VMware DC(s) associated with a zone.", - "isasync": false, - "name": "listVmwareDcs", + "description": "Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.", + "isasync": true, + "name": "createNetworkACLList", "params": [ { - "description": "", + "description": "Description of the network ACL list", "length": 255, - "name": "pagesize", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "Name of the network ACL list", "length": 255, - "name": "keyword", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "Id of the CloudStack zone.", + "description": "ID of the VPC associated with this network ACL list", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, "type": "uuid" } ], - "related": "addVmwareDc", + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "Description of the ACL", + "name": "description", "type": "string" }, {}, - {}, { - "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 Datacenter name", - "name": "name", + "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", - "type": "integer" - } - ] - }, - { - "description": "Stops a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "stopKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, + "description": "the ID of the ACL", "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] } - ] + ], + "count": 826 } diff --git a/test/QuotaService_test.go b/test/QuotaService_test.go index 8d1c04fe..0835ccdd 100644 --- a/test/QuotaService_test.go +++ b/test/QuotaService_test.go @@ -35,6 +35,30 @@ func TestQuotaService(t *testing.T) { client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) defer server.Close() + testquotaBalance := func(t *testing.T) { + if _, ok := response["quotaBalance"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaBalanceParams("account", "domainid") + _, err := client.Quota.QuotaBalance(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaBalance", testquotaBalance) + + testquotaCredits := func(t *testing.T) { + if _, ok := response["quotaCredits"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaCreditsParams("account", "domainid", 0) + _, err := client.Quota.QuotaCredits(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaCredits", testquotaCredits) + testquotaIsEnabled := func(t *testing.T) { if _, ok := response["quotaIsEnabled"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") @@ -47,4 +71,94 @@ func TestQuotaService(t *testing.T) { } t.Run("QuotaIsEnabled", testquotaIsEnabled) + testquotaStatement := func(t *testing.T) { + if _, ok := response["quotaStatement"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaStatementParams("account", "domainid", "enddate", "startdate") + _, err := client.Quota.QuotaStatement(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaStatement", testquotaStatement) + + testquotaSummary := func(t *testing.T) { + if _, ok := response["quotaSummary"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaSummaryParams() + _, err := client.Quota.QuotaSummary(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaSummary", testquotaSummary) + + testquotaTariffCreate := func(t *testing.T) { + if _, ok := response["quotaTariffCreate"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaTariffCreateParams("name", 0, 0) + r, err := client.Quota.QuotaTariffCreate(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("QuotaTariffCreate", testquotaTariffCreate) + + testquotaTariffDelete := func(t *testing.T) { + if _, ok := response["quotaTariffDelete"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaTariffDeleteParams("id") + _, err := client.Quota.QuotaTariffDelete(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaTariffDelete", testquotaTariffDelete) + + testquotaTariffList := func(t *testing.T) { + if _, ok := response["quotaTariffList"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaTariffListParams() + _, err := client.Quota.QuotaTariffList(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaTariffList", testquotaTariffList) + + testquotaTariffUpdate := func(t *testing.T) { + if _, ok := response["quotaTariffUpdate"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaTariffUpdateParams("name") + r, err := client.Quota.QuotaTariffUpdate(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("QuotaTariffUpdate", testquotaTariffUpdate) + + testquotaUpdate := func(t *testing.T) { + if _, ok := response["quotaUpdate"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Quota.NewQuotaUpdateParams() + _, err := client.Quota.QuotaUpdate(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("QuotaUpdate", testquotaUpdate) + }